oak-domain 1.0.4 → 1.1.2

package/lib/actions/action.d.ts

@@ -1,5 +1,13 @@
 import { ActionDef } from '../types/Action';
-export declare type GenericAction = 'create' | 'update' | 'remove' | 'select' | 'count' | 'stat' | 'download';
+export declare type ReadOnlyAction = 'select' | 'count' | 'stat' | 'download';
+export declare type AppendOnlyAction = ReadOnlyAction | 'create';
+export declare type ExcludeUpdateAction = AppendOnlyAction | 'remove';
+export declare type ExcludeRemoveAction = AppendOnlyAction | 'update';
+export declare type GenericAction = 'update' | ExcludeUpdateAction;
+export declare const readOnlyActions: string[];
+export declare const appendOnlyActions: string[];
+export declare const excludeUpdateActions: string[];
+export declare const exludeRemoveActions: string[];
 export declare const genericActions: string[];
 export declare type AbleAction = 'enable' | 'disable';
 export declare type AbleState = 'enabled' | 'disabled';

package/lib/actions/action.js

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAbleActionDef = exports.genericActions = void 0;
-exports.genericActions = ['create', 'update', 'remove', 'count', 'stat', 'download', 'select'];
+exports.makeAbleActionDef = exports.genericActions = exports.exludeRemoveActions = exports.excludeUpdateActions = exports.appendOnlyActions = exports.readOnlyActions = void 0;
+exports.readOnlyActions = ['count', 'stat', 'download', 'select'];
+exports.appendOnlyActions = exports.readOnlyActions.concat('create');
+exports.excludeUpdateActions = exports.appendOnlyActions.concat('remove');
+exports.exludeRemoveActions = exports.appendOnlyActions.concat('update');
+exports.genericActions = exports.excludeUpdateActions.concat('update');
 var makeAbleActionDef = function (initialState) { return ({
     stm: {
         enable: ['disabled', 'enabled'],

package/lib/base-app-domain/ActionDefDict.d.ts

@@ -0,0 +1,5 @@
+export declare const ActionDefDict: {
+    modi: {
+        iState: import("../types").ActionDef<import("./Modi/Action").IAction, import("./Modi/Action").IState>;
+    };
+};

package/lib/base-app-domain/ActionDefDict.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionDefDict = void 0;
+var Action_1 = require("./Modi/Action");
+exports.ActionDefDict = {
+    modi: Action_1.ActionDefDict
+};

package/lib/base-app-domain/EntityDict.d.ts

@@ -0,0 +1,12 @@
+import { EntityDef as Modi } from "./Modi/Schema";
+import { EntityDef as ModiEntity } from "./ModiEntity/Schema";
+import { EntityDef as Oper } from "./Oper/Schema";
+import { EntityDef as OperEntity } from "./OperEntity/Schema";
+import { EntityDef as User } from "./User/Schema";
+export declare type EntityDict = {
+    modi: Modi;
+    modiEntity: ModiEntity;
+    oper: Oper;
+    operEntity: OperEntity;
+    user: User;
+};

package/lib/base-app-domain/EntityDict.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/base-app-domain/Modi/Action.d.ts

@@ -0,0 +1,10 @@
+import { ActionDef } from "../../types/Action";
+import { GenericAction } from "../../actions/action";
+export declare type IState = 'active' | 'applied' | 'abandoned';
+export declare type IAction = 'apply' | 'abandon';
+export declare type ParticularAction = IAction;
+export declare type Action = GenericAction | ParticularAction;
+export declare const actions: string[];
+export declare const ActionDefDict: {
+    iState: ActionDef<IAction, IState>;
+};

package/lib/base-app-domain/Modi/Action.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionDefDict = exports.actions = void 0;
+var IActionDef = {
+    stm: {
+        apply: ['active', 'applied'],
+        abandon: ['active', 'abandoned']
+    },
+    is: 'active'
+};
+exports.actions = ["count", "stat", "download", "select", "create", "remove", "update", "apply", "abandon"];
+exports.ActionDefDict = {
+    iState: IActionDef
+};

package/lib/base-app-domain/Modi/Schema.d.ts

@@ -0,0 +1,164 @@
+import { String, Datetime, PrimaryKey } from "../../types/DataType";
+import { Q_DateValue, Q_StringValue, Q_EnumValue, NodeId, MakeFilter, ExprOp, ExpressionKey } from "../../types/Demand";
+import { OneOf } from "../../types/Polyfill";
+import * as SubQuery from "../_SubQuery";
+import { FormCreateData, FormUpdateData, Operation as OakOperation, MakeAction as OakMakeAction } from "../../types/Entity";
+import { Action, ParticularAction, IState } from "./Action";
+import * as ModiEntity from "../ModiEntity/Schema";
+import * as OperEntity from "../OperEntity/Schema";
+export declare type OpSchema = {
+    id: PrimaryKey;
+    $$createAt$$: Datetime;
+    $$updateAt$$: Datetime;
+    $$deleteAt$$?: Datetime | null;
+    targetEntity: String<32>;
+    entity: String<32>;
+    entityId: String<64>;
+    action: String<16>;
+    data: Object;
+    filter?: Object | null;
+    extra?: Object | null;
+    iState?: IState | null;
+};
+export declare type OpAttr = keyof OpSchema;
+export declare type Schema = {
+    id: PrimaryKey;
+    $$createAt$$: Datetime;
+    $$updateAt$$: Datetime;
+    $$deleteAt$$?: Datetime | null;
+    targetEntity: String<32>;
+    entity: String<32>;
+    entityId: String<64>;
+    action: String<16>;
+    data: Object;
+    filter?: Object | null;
+    extra?: Object | null;
+    iState?: IState | null;
+    modiEntity$modi?: Array<ModiEntity.Schema>;
+    operEntity$entity?: Array<OperEntity.Schema>;
+} & {
+    [A in ExpressionKey]?: any;
+};
+declare type AttrFilter = {
+    id: Q_StringValue | SubQuery.ModiIdSubQuery;
+    $$createAt$$: Q_DateValue;
+    $$updateAt$$: Q_DateValue;
+    targetEntity: Q_StringValue;
+    entity: Q_StringValue;
+    entityId: Q_StringValue;
+    action: Q_StringValue;
+    data: Object;
+    filter: Object;
+    extra: Object;
+    iState: Q_EnumValue<IState>;
+};
+export declare type Filter = MakeFilter<AttrFilter & ExprOp<OpAttr | string>>;
+export declare type Projection = {
+    "#id"?: NodeId;
+    [k: string]: any;
+    id: 1;
+    $$createAt$$?: 1;
+    $$updateAt$$?: 1;
+    targetEntity?: 1;
+    entity?: 1;
+    entityId?: 1;
+    action?: 1;
+    data?: 1;
+    filter?: 1;
+    extra?: 1;
+    iState?: 1;
+    modiEntity$modi?: ModiEntity.Selection & {
+        $entity: "modiEntity";
+    };
+    operEntity$entity?: OperEntity.Selection & {
+        $entity: "operEntity";
+    };
+} & Partial<ExprOp<OpAttr | string>>;
+export declare type ExportProjection = {
+    "#id"?: NodeId;
+    [k: string]: any;
+    id?: string;
+    $$createAt$$?: string;
+    $$updateAt$$?: string;
+    targetEntity?: string;
+    entity?: string;
+    entityId?: string;
+    action?: string;
+    data?: string;
+    filter?: string;
+    extra?: string;
+    iState?: string;
+    modiEntity$modi?: ModiEntity.Exportation & {
+        $entity: "modiEntity";
+    };
+    operEntity$entity?: OperEntity.Exportation & {
+        $entity: "operEntity";
+    };
+} & Partial<ExprOp<OpAttr | string>>;
+declare type ModiIdProjection = OneOf<{
+    id: 1;
+}>;
+export declare type SortAttr = {
+    id: 1;
+} | {
+    $$createAt$$: 1;
+} | {
+    $$updateAt$$: 1;
+} | {
+    targetEntity: 1;
+} | {
+    entity: 1;
+} | {
+    entityId: 1;
+} | {
+    action: 1;
+} | {
+    iState: 1;
+} | {
+    [k: string]: any;
+} | OneOf<ExprOp<OpAttr | string>>;
+export declare type SortNode = {
+    $attr: SortAttr;
+    $direction?: "asc" | "desc";
+};
+export declare type Sorter = SortNode[];
+export declare type SelectOperation<P extends Object = Projection> = Omit<OakOperation<"select", P, Filter, Sorter>, "id">;
+export declare type Selection<P extends Object = Projection> = Omit<SelectOperation<P>, "action">;
+export declare type Exportation = OakOperation<"export", ExportProjection, Filter, Sorter>;
+export declare type CreateOperationData = FormCreateData<Omit<OpSchema, "entity" | "entityId">> & ({
+    entity?: string;
+    entityId?: string;
+    [K: string]: any;
+}) & {
+    modiEntity$modi?: OakOperation<"create", Omit<ModiEntity.CreateOperationData, "modi" | "modiId">[]> | Array<OakOperation<"create", Omit<ModiEntity.CreateOperationData, "modi" | "modiId">>>;
+    operEntity$entity?: OakOperation<"create", Omit<OperEntity.CreateOperationData, "entity" | "entityId">[]> | Array<OakOperation<"create", Omit<OperEntity.CreateOperationData, "entity" | "entityId">>>;
+};
+export declare type CreateSingleOperation = OakOperation<"create", CreateOperationData>;
+export declare type CreateMultipleOperation = OakOperation<"create", Array<CreateOperationData>>;
+export declare type CreateOperation = CreateSingleOperation | CreateMultipleOperation;
+export declare type UpdateOperationData = FormUpdateData<OpSchema> & {
+    [k: string]: any;
+    modiEntitys$modi?: OakOperation<"create", Omit<ModiEntity.CreateOperationData, "modi" | "modiId">[]> | Array<OakOperation<"create", Omit<ModiEntity.CreateOperationData, "modi" | "modiId">>>;
+    operEntitys$entity?: OakOperation<"create", Omit<OperEntity.CreateOperationData, "entity" | "entityId">[]> | Array<OakOperation<"create", Omit<OperEntity.CreateOperationData, "entity" | "entityId">>>;
+};
+export declare type UpdateOperation = OakOperation<ParticularAction | "update" | string, UpdateOperationData, Filter, Sorter>;
+export declare type RemoveOperationData = {};
+export declare type RemoveOperation = OakOperation<"remove", RemoveOperationData, Filter, Sorter>;
+export declare type Operation = CreateOperation | UpdateOperation | RemoveOperation | SelectOperation;
+export declare type ModiIdSubQuery = Selection<ModiIdProjection>;
+export declare type NativeAttr = OpAttr;
+export declare type FullAttr = NativeAttr | `modiEntitys$${number}.${ModiEntity.NativeAttr}` | `operEntitys$${number}.${OperEntity.NativeAttr}`;
+export declare type EntityDef = {
+    Schema: Schema;
+    OpSchema: OpSchema;
+    Action: OakMakeAction<Action> | string;
+    Selection: Selection;
+    Operation: Operation;
+    Create: CreateOperation;
+    Update: UpdateOperation;
+    Remove: RemoveOperation;
+    CreateSingle: CreateSingleOperation;
+    CreateMulti: CreateMultipleOperation;
+    ParticularAction: ParticularAction;
+};
+export {};

package/lib/base-app-domain/Modi/Schema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/base-app-domain/Modi/Storage.d.ts

@@ -0,0 +1,3 @@
+import { StorageDesc } from "../../types/Storage";
+import { OpSchema } from "./Schema";
+export declare const desc: StorageDesc<OpSchema>;

package/lib/base-app-domain/Modi/Storage.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.desc = void 0;
+var Action_1 = require("./Action");
+exports.desc = {
+    attributes: {
+        targetEntity: {
+            type: "varchar",
+            params: {
+                length: 32
+            }
+        },
+        entity: {
+            type: "varchar",
+            params: {
+                length: 32
+            }
+        },
+        entityId: {
+            type: "varchar",
+            params: {
+                length: 64
+            }
+        },
+        action: {
+            type: "varchar",
+            params: {
+                length: 16
+            }
+        },
+        data: {
+            type: "object"
+        },
+        filter: {
+            type: "object"
+        },
+        extra: {
+            type: "object"
+        },
+        iState: {
+            type: "varchar",
+            params: {
+                length: 16
+            }
+        }
+    },
+    actionType: "crud",
+    actions: Action_1.actions,
+    indexes: [
+        {
+            name: 'index_state',
+            attributes: [
+                {
+                    name: 'iState',
+                    direction: 'ASC'
+                }
+            ]
+        }
+    ]
+};

package/lib/base-app-domain/ModiEntity/Schema.d.ts

@@ -0,0 +1,179 @@
+import { String, Datetime, PrimaryKey, ForeignKey } from "../../types/DataType";
+import { Q_DateValue, Q_StringValue, Q_EnumValue, NodeId, MakeFilter, ExprOp, ExpressionKey } from "../../types/Demand";
+import { OneOf } from "../../types/Polyfill";
+import * as SubQuery from "../_SubQuery";
+import { FormCreateData, FormUpdateData, Operation as OakOperation, MakeAction as OakMakeAction } from "../../types/Entity";
+import { AppendOnlyAction } from "../../actions/action";
+import * as Modi from "../Modi/Schema";
+import * as User from "../User/Schema";
+export declare type OpSchema = {
+    id: PrimaryKey;
+    $$createAt$$: Datetime;
+    $$updateAt$$: Datetime;
+    $$deleteAt$$?: Datetime | null;
+    modiId: ForeignKey<"modi">;
+    entity: "user" | string;
+    entityId: String<64>;
+};
+export declare type OpAttr = keyof OpSchema;
+export declare type Schema = {
+    id: PrimaryKey;
+    $$createAt$$: Datetime;
+    $$updateAt$$: Datetime;
+    $$deleteAt$$?: Datetime | null;
+    modiId: ForeignKey<"modi">;
+    entity: "user" | string;
+    entityId: String<64>;
+    modi: Modi.Schema;
+    user?: User.Schema;
+} & {
+    [A in ExpressionKey]?: any;
+};
+declare type AttrFilter<E> = {
+    id: Q_StringValue | SubQuery.ModiEntityIdSubQuery;
+    $$createAt$$: Q_DateValue;
+    $$updateAt$$: Q_DateValue;
+    modiId: Q_StringValue | SubQuery.ModiIdSubQuery;
+    modi: Modi.Filter;
+    entity: E;
+    entityId: Q_StringValue;
+    user: User.Filter;
+};
+export declare type Filter<E = Q_EnumValue<"user" | string>> = MakeFilter<AttrFilter<E> & ExprOp<OpAttr | string>>;
+export declare type Projection = {
+    "#id"?: NodeId;
+    [k: string]: any;
+    id: 1;
+    $$createAt$$?: 1;
+    $$updateAt$$?: 1;
+    modiId?: 1;
+    modi?: Modi.Projection;
+    entity?: 1;
+    entityId?: 1;
+    user?: User.Projection;
+} & Partial<ExprOp<OpAttr | string>>;
+export declare type ExportProjection = {
+    "#id"?: NodeId;
+    [k: string]: any;
+    id?: string;
+    $$createAt$$?: string;
+    $$updateAt$$?: string;
+    modiId?: string;
+    modi?: Modi.ExportProjection;
+    entity?: string;
+    entityId?: string;
+    user?: User.ExportProjection;
+} & Partial<ExprOp<OpAttr | string>>;
+declare type ModiEntityIdProjection = OneOf<{
+    id: 1;
+}>;
+declare type ModiIdProjection = OneOf<{
+    modiId: 1;
+}>;
+declare type UserIdProjection = OneOf<{
+    entityId: 1;
+}>;
+export declare type SortAttr = {
+    id: 1;
+} | {
+    $$createAt$$: 1;
+} | {
+    $$updateAt$$: 1;
+} | {
+    modiId: 1;
+} | {
+    modi: Modi.SortAttr;
+} | {
+    entity: 1;
+} | {
+    entityId: 1;
+} | {
+    user: User.SortAttr;
+} | {
+    [k: string]: any;
+} | OneOf<ExprOp<OpAttr | string>>;
+export declare type SortNode = {
+    $attr: SortAttr;
+    $direction?: "asc" | "desc";
+};
+export declare type Sorter = SortNode[];
+export declare type SelectOperation<P extends Object = Projection> = Omit<OakOperation<"select", P, Filter, Sorter>, "id">;
+export declare type Selection<P extends Object = Projection> = Omit<SelectOperation<P>, "action">;
+export declare type Exportation = OakOperation<"export", ExportProjection, Filter, Sorter>;
+export declare type CreateOperationData = FormCreateData<Omit<OpSchema, "entity" | "entityId" | "modiId">> & (({
+    modiId?: never;
+    modi: Modi.CreateSingleOperation;
+} | {
+    modiId: String<64>;
+    modi?: Modi.UpdateOperation;
+} | {
+    modiId: String<64>;
+})) & ({
+    entity?: never;
+    entityId?: never;
+    user: User.CreateSingleOperation;
+} | {
+    entity: "user";
+    entityId: String<64>;
+    user: User.UpdateOperation;
+} | {
+    entity: "user";
+    entityId: String<64>;
+} | {
+    entity?: string;
+    entityId?: string;
+    [K: string]: any;
+});
+export declare type CreateSingleOperation = OakOperation<"create", CreateOperationData>;
+export declare type CreateMultipleOperation = OakOperation<"create", Array<CreateOperationData>>;
+export declare type CreateOperation = CreateSingleOperation | CreateMultipleOperation;
+export declare type UpdateOperationData = FormUpdateData<Omit<OpSchema, "entity" | "entityId" | "modiId">> & (({
+    modi: Modi.CreateSingleOperation;
+    modiId?: never;
+} | {
+    modi: Modi.UpdateOperation;
+    modiId?: never;
+} | {
+    modi: Modi.RemoveOperation;
+    modiId?: never;
+} | {
+    modi?: never;
+    modiId?: String<64> | null;
+})) & ({
+    user?: User.CreateSingleOperation | User.UpdateOperation | User.RemoveOperation;
+    entityId?: never;
+    entity?: never;
+} | {
+    entity?: ("user" | string) | null;
+    entityId?: String<64> | null;
+}) & {
+    [k: string]: any;
+};
+export declare type UpdateOperation = OakOperation<"update" | string, UpdateOperationData, Filter, Sorter>;
+export declare type RemoveOperationData = {} & (({
+    modi?: Modi.UpdateOperation | Modi.RemoveOperation;
+})) & ({
+    user?: User.UpdateOperation | User.RemoveOperation;
+} | {
+    [k: string]: any;
+});
+export declare type RemoveOperation = OakOperation<"remove", RemoveOperationData, Filter, Sorter>;
+export declare type Operation = CreateOperation | UpdateOperation | RemoveOperation | SelectOperation;
+export declare type ModiIdSubQuery = Selection<ModiIdProjection>;
+export declare type UserIdSubQuery = Selection<UserIdProjection>;
+export declare type ModiEntityIdSubQuery = Selection<ModiEntityIdProjection>;
+export declare type NativeAttr = OpAttr | `modi.${Modi.NativeAttr}` | `entity.${User.NativeAttr}`;
+export declare type FullAttr = NativeAttr;
+export declare type EntityDef = {
+    Schema: Schema;
+    OpSchema: OpSchema;
+    Action: OakMakeAction<AppendOnlyAction> | string;
+    Selection: Selection;
+    Operation: Operation;
+    Create: CreateOperation;
+    Update: UpdateOperation;
+    Remove: RemoveOperation;
+    CreateSingle: CreateSingleOperation;
+    CreateMulti: CreateMultipleOperation;
+};
+export {};

package/lib/base-app-domain/ModiEntity/Schema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/base-app-domain/ModiEntity/Storage.d.ts

@@ -0,0 +1,3 @@
+import { StorageDesc } from "../../types/Storage";
+import { OpSchema } from "./Schema";
+export declare const desc: StorageDesc<OpSchema>;

package/lib/base-app-domain/ModiEntity/Storage.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.desc = void 0;
+var action_1 = require("../../actions/action");
+exports.desc = {
+    attributes: {
+        modiId: {
+            type: "ref",
+            ref: "modi"
+        },
+        entity: {
+            type: "varchar",
+            params: {
+                length: 32
+            }
+        },
+        entityId: {
+            type: "varchar",
+            params: {
+                length: 64
+            }
+        }
+    },
+    actionType: "appendOnly",
+    actions: action_1.appendOnlyActions
+};