akanjs 2.2.4 → 2.2.5

package/types/signal/types.d.ts

@@ -0,0 +1,142 @@
+import type { DefaultPrimitiveName, UnCls } from "akanjs/base";
+import type { ServiceModel } from "akanjs/service";
+import type { GuardCls } from "./guard.d.ts";
+import type { MiddlewareCls } from "./middleware.d.ts";
+import type { SliceCls } from "./slice.d.ts";
+export type CnstOf<S extends ServiceModel> = NonNullable<S["cnst"]>;
+export type DbOf<S extends ServiceModel> = NonNullable<S["db"]>;
+export type CnstRefName<S extends ServiceModel> = CnstOf<S>["refName"];
+export type CnstInput<S extends ServiceModel> = CnstOf<S>["_Input"];
+export type CnstFull<S extends ServiceModel> = CnstOf<S>["_Full"];
+export type CnstLight<S extends ServiceModel> = CnstOf<S>["_Light"];
+export type CnstInsight<S extends ServiceModel> = CnstOf<S>["_Insight"];
+export type CnstDefault<S extends ServiceModel> = CnstOf<S>["_Default"];
+export type CnstDefaultInput<S extends ServiceModel> = CnstOf<S>["_DefaultInput"];
+export type CnstDefaultState<S extends ServiceModel> = CnstOf<S>["_DefaultState"];
+export type CnstStateLight<S extends ServiceModel> = CnstOf<S>["_StateLight"];
+export type CnstStateInsight<S extends ServiceModel> = CnstOf<S>["_StateInsight"];
+export type CnstPurifiedInput<S extends ServiceModel> = CnstOf<S>["_PurifiedInput"];
+export type CnstCapitalizedRefName<S extends ServiceModel> = CnstOf<S>["_CapitalizedRefName"];
+export type DbFilter<S extends ServiceModel> = DbOf<S>["_Filter"];
+export type DbSort<S extends ServiceModel> = DbOf<S>["_Sort"];
+export type SlceSrv<S extends SliceCls> = S["srv"];
+export type SlceCnstRefName<S extends SliceCls> = S["srv"]["cnst"]["refName"];
+export type SlceCnstInput<S extends SliceCls> = S["srv"]["cnst"]["_Input"];
+export type SlceCnstFull<S extends SliceCls> = S["srv"]["cnst"]["_Full"];
+export type SlceCnstLight<S extends SliceCls> = S["srv"]["cnst"]["_Light"];
+export type SlceCnstInsight<S extends SliceCls> = S["srv"]["cnst"]["_Insight"];
+export type SlceCnstDefault<S extends SliceCls> = S["srv"]["cnst"]["_Default"];
+export type SlceCnstDefaultInput<S extends SliceCls> = S["srv"]["cnst"]["_DefaultInput"];
+export type SlceCnstDefaultState<S extends SliceCls> = S["srv"]["cnst"]["_DefaultState"];
+export type SlceCnstPurifiedInput<S extends SliceCls> = S["srv"]["cnst"]["_PurifiedInput"];
+export type SlceCnstCapitalizedRefName<S extends SliceCls> = S["srv"]["cnst"]["_CapitalizedRefName"];
+export type SlceCnstStateLight<S extends SliceCls> = S["srv"]["cnst"]["_StateLight"];
+export type SlceCnstStateInsight<S extends SliceCls> = S["srv"]["cnst"]["_StateInsight"];
+export type SlceDbFilter<S extends SliceCls> = S["srv"]["db"]["_Filter"];
+export type SlceDbSort<S extends SliceCls> = S["srv"]["db"]["_Sort"];
+export declare const argTypes: readonly ["body", "param", "search", "upload", "msg", "room"];
+export type ArgType = (typeof argTypes)[number];
+interface InitOption {
+    serverMode?: "federation" | "batch" | "all";
+    operationMode?: ("cloud" | "edge" | "local" | (string & {}))[];
+    enabled?: boolean;
+}
+interface TimerOption {
+    serverMode?: "federation" | "batch" | "all";
+    operationMode?: ("cloud" | "edge" | "local" | (string & {}))[];
+    lock?: boolean;
+    enabled?: boolean;
+}
+export interface SignalOption<Response = any, Nullable extends boolean = false, _Key = keyof UnCls<Response>> extends InitOption, TimerOption {
+    nullable?: Nullable;
+    name?: string;
+    default?: boolean;
+    path?: string;
+    serverMode?: "federation" | "batch" | "all";
+    timeout?: number;
+    partial?: _Key[] | readonly _Key[];
+    cache?: number;
+    guards?: GuardCls[];
+    middlewares?: MiddlewareCls[];
+    prefix?: false | string;
+    globalPrefix?: false;
+    /** Marks this mutation as the framework file-upload endpoint (see resolveFileUploadCapability). */
+    fileUpload?: boolean;
+    scheduleType?: "init" | "destroy" | "cron" | "interval" | "timeout";
+    scheduleCron?: string;
+    scheduleTime?: number;
+    lock?: boolean;
+    enabled?: boolean;
+}
+interface SerializedSignalOption {
+    args: SerializedArg[];
+    path?: string;
+    prefix?: false | string;
+    globalPrefix?: false;
+    guards?: string[];
+    fileUpload?: boolean;
+}
+export interface SerializedSlice extends SerializedSignalOption {
+}
+export interface SerializedReturns {
+    refName: Exclude<DefaultPrimitiveName, "Map" | "Upload"> | (string & {});
+    modelType?: "input" | "full" | "light" | "insight" | "scalar";
+    arrDepth?: number;
+    partial?: string[];
+    nullable?: boolean;
+}
+export interface SerializedArg {
+    type: ArgType;
+    refName: Exclude<DefaultPrimitiveName, "Map"> | (string & {});
+    name: string;
+    modelType?: "input" | "object" | "insight" | "scalar";
+    arrDepth?: number;
+    nullable?: boolean;
+    example?: string | number | boolean | Date;
+    enum?: string;
+}
+export interface SerializedEndpoint extends SerializedSignalOption {
+    type: "query" | "mutation" | "pubsub" | "message";
+    returns: SerializedReturns;
+}
+export interface SerializedFilter {
+    filter: {
+        [key: string]: SerializedArg[];
+    };
+    sortKeys: string[];
+}
+export interface SerializedSignal {
+    prefix?: string;
+    slice?: {
+        [key: string]: SerializedSlice;
+    };
+    endpoint: {
+        [key: string]: SerializedEndpoint;
+    };
+    filter?: SerializedFilter;
+    getGuards?: string[];
+    cruGuards?: string[];
+}
+export type SignalType = "restapi" | "websocket";
+export type WebsocketReqData = {
+    key: string;
+    data: unknown[];
+    subscribe?: boolean;
+};
+export type WebsocketMessageData = {
+    type: "msg";
+    key: string;
+    data: object | object[];
+};
+export type WebsocketSubscribeAck = {
+    type: "sub";
+    roomId: string;
+    subscribe: boolean;
+};
+export type WebsocketPublishData = {
+    type: "pub";
+    roomId: string;
+    data: object | object[];
+};
+export type WebsocketResData = WebsocketMessageData | WebsocketSubscribeAck | WebsocketPublishData;
+export {};

package/types/signal.d.ts

@@ -0,0 +1 @@
+export * from "./signal/index.d.ts";

package/types/store/action.d.ts

@@ -0,0 +1,145 @@
+import { type GetStateObject, type SLICE_META } from "akanjs/base";
+import { type FetchPolicy } from "akanjs/common";
+import { type DefaultOf, type FieldState, type ProtoFile } from "akanjs/constant";
+import type { ExtractSort, FilterInstance } from "akanjs/document";
+import type { FetchInitForm, FetchProxy } from "akanjs/fetch";
+import type { SerializedSlice, SliceCls, SliceInfoArgs } from "akanjs/signal";
+import type { SetGet } from "./types.d.ts";
+export interface CreateOption<Full extends {
+    id: string;
+}> {
+    idx?: number;
+    path?: string;
+    modal?: string;
+    sliceName?: string;
+    onError?: (e: string) => void;
+    onSuccess?: (model: Full) => void | Promise<void>;
+}
+export interface NewOption {
+    modal?: string;
+    setDefault?: boolean;
+    sliceName?: string;
+}
+type PartialOrNull<O> = {
+    [K in keyof O]?: O[K] | null;
+};
+type BaseAction<RefName extends string, Input, Full extends {
+    id: string;
+}, Light, _CapitalizedRefName extends string = Capitalize<RefName>, _CreateOption = CreateOption<Full>, _InputData = GetStateObject<Input>> = {
+    [K in `create${_CapitalizedRefName}InForm`]: (options?: _CreateOption) => Promise<void>;
+} & {
+    [K in `update${_CapitalizedRefName}InForm`]: (options?: _CreateOption) => Promise<void>;
+} & {
+    [K in `create${_CapitalizedRefName}`]: (data: _InputData, options?: _CreateOption) => Promise<void>;
+} & {
+    [K in `update${_CapitalizedRefName}`]: (id: string, data: _InputData, options?: _CreateOption) => Promise<void>;
+} & {
+    [K in `remove${_CapitalizedRefName}`]: (id: string, options?: FetchPolicy & {
+        modal?: string | null;
+    }) => Promise<void>;
+} & {
+    [K in `check${_CapitalizedRefName}Submitable`]: (disabled?: boolean) => Promise<void>;
+} & {
+    [K in `submit${_CapitalizedRefName}`]: (options?: _CreateOption) => Promise<void>;
+} & {
+    [K in `new${_CapitalizedRefName}`]: (partial?: PartialOrNull<Full>, options?: NewOption) => void;
+} & {
+    [K in `edit${_CapitalizedRefName}`]: (model: Full | string, options?: {
+        modal?: string | null;
+    } & FetchPolicy) => Promise<void>;
+} & {
+    [K in `merge${_CapitalizedRefName}`]: (model: Full | string, data: Partial<Full>, options?: FetchPolicy) => Promise<void>;
+} & {
+    [K in `view${_CapitalizedRefName}`]: (model: Full | string, options?: {
+        modal?: string | null;
+    } & FetchPolicy) => Promise<void>;
+} & {
+    [K in `set${_CapitalizedRefName}`]: (...models: (Full | Light)[]) => void;
+} & {
+    [K in `reset${_CapitalizedRefName}`]: (model?: Full) => void;
+};
+export type SliceAction<RefName extends string, Suffix extends string, Input, Light, QueryArgs extends any[], Filter extends FilterInstance, _CapitalizedRefName extends string = Capitalize<RefName>, _CapitalizedSuffix extends string = Capitalize<Suffix>, _Sort = ExtractSort<Filter>, _FetchInitFormWithFetchPolicy = FetchInitForm<Input, Filter, DefaultOf<Input>, _Sort> & FetchPolicy> = {
+    [KDefaultOf in `init${_CapitalizedRefName}${_CapitalizedSuffix}`]: (...args: [...args: QueryArgs, initForm?: _FetchInitFormWithFetchPolicy]) => Promise<void>;
+} & {
+    [K in `refresh${_CapitalizedRefName}${_CapitalizedSuffix}`]: (initForm?: _FetchInitFormWithFetchPolicy & {
+        queryArgs?: QueryArgs;
+    }) => Promise<void>;
+} & {
+    [K in `select${_CapitalizedRefName}${_CapitalizedSuffix}`]: (model: Light | Light[], options?: {
+        refresh?: boolean;
+        remove?: boolean;
+    }) => void;
+} & {
+    [K in `setPageOf${_CapitalizedRefName}${_CapitalizedSuffix}`]: (page: number, options?: FetchPolicy) => Promise<void>;
+} & {
+    [K in `addPageOf${_CapitalizedRefName}${_CapitalizedSuffix}`]: (page: number, options?: FetchPolicy) => Promise<void>;
+} & {
+    [K in `setLimitOf${_CapitalizedRefName}${_CapitalizedSuffix}`]: (limit: number, options?: FetchPolicy) => Promise<void>;
+} & {
+    [K in `setQueryArgsOf${_CapitalizedRefName}${_CapitalizedSuffix}`]: (...args: [...args: QueryArgs, options?: FetchPolicy] | [setQueryArgs: (...prevQueryArgs: QueryArgs) => QueryArgs, options?: FetchPolicy]) => Promise<void>;
+} & {
+    [K in `setSortOf${_CapitalizedRefName}${_CapitalizedSuffix}`]: (sort: _Sort, options?: FetchPolicy) => Promise<void>;
+};
+type SingleOf<M> = M extends (infer V)[] ? V : never;
+type SetterKey<Prefix extends string, Key extends string, RefName extends string, _CapitalizedRefName extends string = Capitalize<RefName>, _CapitalizedK extends string = Capitalize<Key>> = `${Prefix}${_CapitalizedK}On${_CapitalizedRefName}`;
+type FieldFormSetter<DefaultState, RefName extends string, _CapitalizedRefName extends string = Capitalize<RefName>> = {
+    [Key in keyof DefaultState as Key extends string ? SetterKey<"set", Key, RefName, _CapitalizedRefName> : never]: (value: FieldState<DefaultState[Key]> | (DefaultState[Key] extends any[] ? never : null)) => void;
+};
+type ArrayFieldAddSetters<RefName extends string, _CapRef extends string, _DefaultState> = {
+    [K in keyof _DefaultState as _DefaultState[K] extends any[] ? K extends string ? SetterKey<"add", K, RefName, _CapRef> : never : never]: (value: DefaultOf<SingleOf<_DefaultState[K]>> | DefaultOf<SingleOf<_DefaultState[K]>>[], options?: {
+        idx?: number;
+        limit?: number;
+    }) => void;
+};
+type ArrayFieldSubSetters<RefName extends string, _CapRef extends string, _DefaultState> = {
+    [K in keyof _DefaultState as _DefaultState[K] extends any[] ? K extends string ? SetterKey<"sub", K, RefName, _CapRef> : never : never]: (idx: number | number[]) => void;
+};
+type ArrayFieldAddOrSubSetters<RefName extends string, _CapRef extends string, _DefaultState> = {
+    [K in keyof _DefaultState as _DefaultState[K] extends any[] ? K extends string ? SetterKey<"addOrSub", K, RefName, _CapRef> : never : never]: (value: DefaultOf<SingleOf<_DefaultState[K]>>, options?: {
+        idx?: number;
+        limit?: number;
+    }) => void;
+};
+type FormSetter<Full, RefName extends string, _CapitalizedRefName extends string = Capitalize<RefName>, _DefaultState = DefaultOf<Full>> = FieldFormSetter<_DefaultState, RefName, _CapitalizedRefName> & ArrayFieldAddSetters<RefName, _CapitalizedRefName, _DefaultState> & ArrayFieldSubSetters<RefName, _CapitalizedRefName, _DefaultState> & ArrayFieldAddOrSubSetters<RefName, _CapitalizedRefName, _DefaultState> & {
+    [K in keyof _DefaultState as _DefaultState[K] extends (ProtoFile | null) | ProtoFile[] ? K extends string ? SetterKey<"upload", K, RefName, _CapitalizedRefName> : never : never]: (fileList: FileList, idx?: number) => Promise<void>;
+} & {
+    [K in `writeOn${_CapitalizedRefName}`]: (path: string | (string | number)[], value: any) => void;
+};
+type _SliceActionMap<SlceCls extends SliceCls> = SlceCls[typeof SLICE_META];
+type _ActSuffixCap<SlceCls extends SliceCls, Suffix extends keyof _SliceActionMap<SlceCls>> = Capitalize<Suffix & string>;
+type _ActArgs<SlceCls extends SliceCls, Suffix extends keyof _SliceActionMap<SlceCls>> = SliceInfoArgs<_SliceActionMap<SlceCls>[Suffix]>;
+type DefaultSliceActionFields<SlceCls extends SliceCls, _CapRef extends string, _FetchInitFormWithFetchPolicy, _Light, _Sort> = {
+    [Suffix in keyof _SliceActionMap<SlceCls> as `init${_CapRef}${_ActSuffixCap<SlceCls, Suffix>}`]: (...args: [...args: _ActArgs<SlceCls, Suffix>, initForm?: _FetchInitFormWithFetchPolicy]) => Promise<void>;
+} & {
+    [Suffix in keyof _SliceActionMap<SlceCls> as `refresh${_CapRef}${_ActSuffixCap<SlceCls, Suffix>}`]: (initForm?: _FetchInitFormWithFetchPolicy & {
+        queryArgs?: _ActArgs<SlceCls, Suffix>;
+    }) => Promise<void>;
+} & {
+    [Suffix in keyof _SliceActionMap<SlceCls> as `select${_CapRef}${_ActSuffixCap<SlceCls, Suffix>}`]: (model: _Light | _Light[], options?: {
+        refresh?: boolean;
+        remove?: boolean;
+    }) => void;
+} & {
+    [Suffix in keyof _SliceActionMap<SlceCls> as `setPageOf${_CapRef}${_ActSuffixCap<SlceCls, Suffix>}`]: (page: number, options?: FetchPolicy) => Promise<void>;
+} & {
+    [Suffix in keyof _SliceActionMap<SlceCls> as `addPageOf${_CapRef}${_ActSuffixCap<SlceCls, Suffix>}`]: (page: number, options?: FetchPolicy) => Promise<void>;
+} & {
+    [Suffix in keyof _SliceActionMap<SlceCls> as `setLimitOf${_CapRef}${_ActSuffixCap<SlceCls, Suffix>}`]: (limit: number, options?: FetchPolicy) => Promise<void>;
+} & {
+    [Suffix in keyof _SliceActionMap<SlceCls> as `setQueryArgsOf${_CapRef}${_ActSuffixCap<SlceCls, Suffix>}`]: (...args: [...args: _ActArgs<SlceCls, Suffix>, options?: FetchPolicy] | [
+        setQueryArgs: (...prevQueryArgs: _ActArgs<SlceCls, Suffix>) => _ActArgs<SlceCls, Suffix>,
+        options?: FetchPolicy
+    ]) => Promise<void>;
+} & {
+    [Suffix in keyof _SliceActionMap<SlceCls> as `setSortOf${_CapRef}${_ActSuffixCap<SlceCls, Suffix>}`]: (sort: _Sort, options?: FetchPolicy) => Promise<void>;
+};
+export type DefaultAction<SlceCls extends SliceCls, _RefName extends string = SlceCls["srv"]["cnst"]["refName"], _Input = SlceCls["srv"]["cnst"]["_Input"], _Full extends {
+    id: string;
+} = SlceCls["srv"]["cnst"]["_Full"], _Light = SlceCls["srv"]["cnst"]["_Light"], _Filter extends FilterInstance = SlceCls["srv"]["db"]["_Filter"], _CapitalizedRefName extends string = Capitalize<_RefName>, _Default = SlceCls["srv"]["cnst"]["_Default"], _DefaultInput = SlceCls["srv"]["cnst"]["_DefaultInput"], _Sort = SlceCls["srv"]["db"]["_Sort"], _CreateOption = CreateOption<_Full>, _FetchInitFormWithFetchPolicy = FetchInitForm<_Input, _Filter, _DefaultInput, _Sort> & FetchPolicy> = BaseAction<_RefName, _Input, _Full, _Light, _CapitalizedRefName, _CreateOption> & FormSetter<_Full, _RefName, _CapitalizedRefName, _Default> & DefaultSliceActionFields<SlceCls, _CapitalizedRefName, _FetchInitFormWithFetchPolicy, _Light, _Sort>;
+export declare const makeFormSetter: (refName: string, fetch: FetchProxy<any>) => {
+    [x: string]: (this: SetGet, path: string | (string | number)[], value: any) => void;
+};
+export declare const makeActions: (refName: string, slice: {
+    [key: string]: SerializedSlice;
+}, fetch: FetchProxy<any>) => {};
+export {};