akanjs 2.2.4-rc.0 → 2.2.4-rc.1

package/fetch/client/fetchClient.ts

@@ -10,6 +10,7 @@ import type {
   SerializedSlice,
   ServiceSignal,
 } from "akanjs/signal";
+import { fileUploadContract, resolveFileUploadCapability } from "akanjs/signal/fileUpload";
 import type { ClientSignal, MergeAllFetchTypes, SliceMeta } from "../fetchType";
 import { memoizeRequestQuery, cookies as requestCookies, headers as requestHeaders } from "../requestStorage";
 import type { GetSliceMetaObjFromDatabaseSignals } from "../types";
@@ -362,18 +363,20 @@ export class FetchClient {
 
     Object.assign(this.handler, {
       [names.addModelFiles]: async (fileList: FileList, parentId?: string, option?: FetchPolicy) => {
+        const cap = resolveFileUploadCapability(this.serializedSignal);
+        const endpoint = cap ? this.serializedSignal[cap.refName]?.endpoint[cap.endpointKey] : undefined;
+        if (!cap || !endpoint)
+          throw new Error(
+            "File upload is not configured. Mark an upload mutation with { fileUpload: true } (e.g. shared FileEndpoint.addFiles).",
+          );
+        const { fields, buildMetas } = fileUploadContract;
         const formData = new FormData();
-        for (let i = 0; i < fileList.length; i++) formData.append("files", fileList[i]);
-        const metas = Array.from(fileList).map((f) => ({
-          lastModifiedAt: new Date(f.lastModified).toISOString(),
-          size: f.size,
-        }));
-        formData.append("metas", JSON.stringify(metas));
-        formData.append("type", refName);
-        if (parentId) formData.append("parentId", parentId);
-        return await this.http.post(`/file/addFilesRestApi`, formData, {
-          headers: { ...(this.jwt ? { Authorization: `Bearer ${this.jwt}` } : {}) },
-        });
+        for (let i = 0; i < fileList.length; i++) formData.append(fields.files, fileList[i]);
+        formData.append(fields.metas, JSON.stringify(buildMetas(fileList)));
+        formData.append(fields.type, refName);
+        if (parentId) formData.append(fields.parentId, parentId);
+        const url = FetchClient.makeHttpUrl(cap.endpointKey, endpoint, cap.prefix, new Map());
+        return await this.http.post(url, formData, { headers: this.#makeAuthHeaders(option) });
       },
     });
   }

package/fetch/serializer/fetch.serializer.ts

@@ -67,6 +67,7 @@ export class FetchSerializer {
       ...(endpointInfo.signalOption.globalPrefix !== undefined
         ? { globalPrefix: endpointInfo.signalOption.globalPrefix }
         : {}),
+      ...(endpointInfo.signalOption.fileUpload ? { fileUpload: true } : {}),
       ...(guards?.length ? { guards } : {}),
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "akanjs",
-  "version": "2.2.4-rc.0",
+  "version": "2.2.4-rc.1",
   "sourceType": "module",
   "type": "module",
   "publishConfig": {

package/service/injectInfo.ts

@@ -259,7 +259,7 @@ export class InjectInfo<
           get: async (key: string) => {
             const getter = injectInfo.get as unknown as (value: unknown) => unknown;
             const value = await cacheAdaptor.hget(`akan:memory:${injectInfo.parentRefName}`, propKey, key);
-            return value === null ? value : getter(value);
+            return value === null ? undefined : getter(value);
           },
           set: async (key: string, value: unknown) => {
             const setter = injectInfo.set as unknown as (value: unknown) => string | number | Buffer;
@@ -346,6 +346,7 @@ export const injectionBuilder = (parentRefName: string) => ({
     const isMap = modelRef === Map;
     if (isMap && !opts.of) throw new Error("of should be provided when modelRef is Map");
     type FieldValue = never extends GetFn ? GetFieldValue<ValueRef, ExplicitType, MapValue> : ReturnType<GetFn>;
+    type MapFieldValue = never extends GetFn ? FieldToValue<MapValue> : ReturnType<GetFn>;
     type IsNullable = DefaultValue extends never ? true : false;
     type UseValue = IsNullable extends true ? FieldValue | null : FieldValue;
     return new InjectInfo<
@@ -356,8 +357,8 @@ export const injectionBuilder = (parentRefName: string) => ({
           : UseValue
         : MapConstructor extends ValueRef
           ? {
-              get: (key: string) => Promise<FieldToValue<MapValue>>;
-              set: (key: string, value: FieldToValue<MapValue>) => Promise<void>;
+              get: (key: string) => Promise<MapFieldValue | undefined>;
+              set: (key: string, value: MapFieldValue) => Promise<void>;
               delete: (key: string) => Promise<void>;
             }
           : { get: () => Promise<UseValue>; set: (value: UseValue) => Promise<void>; delete: () => Promise<void> },

package/signal/fileUpload.ts

@@ -0,0 +1,35 @@
+import type { SerializedSignal } from "./types";
+
+/**
+ * Framework-owned file-upload contract. A plugin opts in by marking exactly one
+ * upload mutation with `{ fileUpload: true }`; the multipart form must use these
+ * field names and the metas shape below.
+ */
+export const fileUploadContract = {
+  fields: { files: "files", metas: "metas", type: "type", parentId: "parentId" },
+  buildMetas: (fileList: FileList) =>
+    Array.from(fileList).map((f) => ({ lastModifiedAt: new Date(f.lastModified).toISOString(), size: f.size })),
+} as const;
+
+export interface FileUploadCapability {
+  refName: string;
+  endpointKey: string;
+  prefix?: string;
+}
+
+/** Discovers the upload endpoint marked with `{ fileUpload: true }` from the serialized signal. */
+export const resolveFileUploadCapability = (serializedSignal: {
+  [key: string]: SerializedSignal;
+}): FileUploadCapability | null => {
+  const matches: FileUploadCapability[] = [];
+  for (const [refName, signal] of Object.entries(serializedSignal))
+    for (const [endpointKey, endpoint] of Object.entries(signal.endpoint))
+      if (endpoint.fileUpload) matches.push({ refName, endpointKey, prefix: signal.prefix });
+  if (matches.length > 1)
+    console.warn(
+      `[akan] Multiple fileUpload endpoints found (${matches
+        .map((m) => `${m.refName}.${m.endpointKey}`)
+        .join(", ")}). Using the first; mark only one mutation with { fileUpload: true }.`,
+    );
+  return matches[0] ?? null;
+};

package/signal/index.ts

@@ -2,6 +2,7 @@ export * from "./base.signal";
 export * from "./endpoint";
 export * from "./endpointInfo";
 export * from "./exception";
+export * from "./fileUpload";
 export * from "./guard";
 export * from "./guards";
 export * from "./intercept";

package/signal/serializer/fetch.serializer.ts

@@ -64,6 +64,7 @@ export class FetchSerializer {
       args: endpointInfo.args.map(FetchSerializer.#serializeArg),
       returns: FetchSerializer.#serializeReturns(endpointInfo),
       ...(endpointInfo.signalOption.path ? { path: endpointInfo.signalOption.path } : {}),
+      ...(endpointInfo.signalOption.fileUpload ? { fileUpload: true } : {}),
       ...(guards?.length ? { guards } : {}),
     };
   }

package/signal/types.ts

@@ -70,6 +70,8 @@ export interface SignalOption<Response = any, Nullable extends boolean = false,
   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;
@@ -84,6 +86,7 @@ interface SerializedSignalOption {
   prefix?: false | string;
   globalPrefix?: false;
   guards?: string[];
+  fileUpload?: boolean;
 }
 export interface SerializedSlice extends SerializedSignalOption {}
 

package/store/action.ts

@@ -12,6 +12,7 @@ import {
 import type { BaseFilterSortKey, ExtractSort, FilterInstance } from "akanjs/document";
 import type { FetchInitForm, FetchProxy } from "akanjs/fetch";
 import type { SerializedSlice, SliceCls, SliceInfoArgs } from "akanjs/signal";
+import { resolveFileUploadCapability } from "akanjs/signal/fileUpload";
 import type { SliceStateKey } from "./state";
 import type { SetGet } from "./types";
 
@@ -277,6 +278,7 @@ export const makeFormSetter = (refName: string, fetch: FetchProxy<any>) => {
   type Light = BaseObject;
   const [fieldName, className] = [refName, capitalize(refName)];
   const modelRef = ConstantRegistry.getDatabase(refName).full;
+  const fileUploadRefName = resolveFileUploadCapability(fetch.serializedSignal)?.refName;
 
   const names = {
     model: fieldName,
@@ -356,7 +358,7 @@ export const makeFormSetter = (refName: string, fetch: FetchProxy<any>) => {
             },
           }
         : {}),
-      ...(field.isClass && ConstantRegistry.getRefName(field.modelRef) === "file"
+      ...(field.isClass && !!fileUploadRefName && ConstantRegistry.getRefName(field.modelRef) === fileUploadRefName
         ? {
             [namesOfField.uploadFieldOnModel]: async function (this: SetGet, fileList: FileList, index?: number) {
               const form = (this.get() as { [key: string]: any })[names.modelForm] as { [key: string]: any };
@@ -383,7 +385,9 @@ export const makeFormSetter = (refName: string, fetch: FetchProxy<any>) => {
                 const intervalKey = setInterval(() => {
                   void (async () => {
                     const currentFile = await (
-                      (fetch as { [key: string]: any }).file as (id: string) => Promise<ProtoFile>
+                      (fetch as { [key: string]: any })[fileUploadRefName as string] as (
+                        id: string,
+                      ) => Promise<ProtoFile>
                     )(file.id);
                     if (field.isArray)
                       this.set((state: { [key: string]: { [key: string]: ProtoFile[] } }) => {

package/types/service/injectInfo.d.ts

@@ -76,8 +76,8 @@ export declare const injectionBuilder: (parentRefName: string) => {
         get?: GetFn;
         set?: (value: ReturnType<GetFn>) => GetFieldValue<ValueRef, ExplicitType>;
     }) => InjectInfo<"memory", Local extends true ? MapConstructor extends ValueRef ? Map<string, FieldToValue<MapValue>> : (DefaultValue extends never ? true : false) extends true ? (never extends GetFn ? GetFieldValue<ValueRef, ExplicitType, MapValue> : ReturnType<GetFn>) | null : never extends GetFn ? GetFieldValue<ValueRef, ExplicitType, MapValue> : ReturnType<GetFn> : MapConstructor extends ValueRef ? {
-        get: (key: string) => Promise<FieldToValue<MapValue>>;
-        set: (key: string, value: FieldToValue<MapValue>) => Promise<void>;
+        get: (key: string) => Promise<(never extends GetFn ? FieldToValue<MapValue> : ReturnType<GetFn>) | undefined>;
+        set: (key: string, value: never extends GetFn ? FieldToValue<MapValue> : ReturnType<GetFn>) => Promise<void>;
         delete: (key: string) => Promise<void>;
     } : {
         get: () => Promise<(DefaultValue extends never ? true : false) extends true ? (never extends GetFn ? GetFieldValue<ValueRef, ExplicitType, MapValue> : ReturnType<GetFn>) | null : never extends GetFn ? GetFieldValue<ValueRef, ExplicitType, MapValue> : ReturnType<GetFn>>;

package/types/signal/fileUpload.d.ts

@@ -0,0 +1,27 @@
+import type { SerializedSignal } from "./types.d.ts";
+/**
+ * Framework-owned file-upload contract. A plugin opts in by marking exactly one
+ * upload mutation with `{ fileUpload: true }`; the multipart form must use these
+ * field names and the metas shape below.
+ */
+export declare const fileUploadContract: {
+    readonly fields: {
+        readonly files: "files";
+        readonly metas: "metas";
+        readonly type: "type";
+        readonly parentId: "parentId";
+    };
+    readonly buildMetas: (fileList: FileList) => {
+        lastModifiedAt: string;
+        size: number;
+    }[];
+};
+export interface FileUploadCapability {
+    refName: string;
+    endpointKey: string;
+    prefix?: string;
+}
+/** Discovers the upload endpoint marked with `{ fileUpload: true }` from the serialized signal. */
+export declare const resolveFileUploadCapability: (serializedSignal: {
+    [key: string]: SerializedSignal;
+}) => FileUploadCapability | null;

package/types/signal/index.d.ts

@@ -2,6 +2,7 @@ export * from "./base.signal";
 export * from "./endpoint.d.ts";
 export * from "./endpointInfo.d.ts";
 export * from "./exception.d.ts";
+export * from "./fileUpload.d.ts";
 export * from "./guard.d.ts";
 export * from "./guards.d.ts";
 export * from "./intercept.d.ts";

package/types/signal/types.d.ts

@@ -60,6 +60,8 @@ export interface SignalOption<Response = any, Nullable extends boolean = false,
     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;
@@ -72,6 +74,7 @@ interface SerializedSignalOption {
     prefix?: false | string;
     globalPrefix?: false;
     guards?: string[];
+    fileUpload?: boolean;
 }
 export interface SerializedSlice extends SerializedSignalOption {
 }

package/types/ui/System/Client.d.ts

@@ -6,9 +6,9 @@ import { type HTMLAttributes, type ReactNode, type RefObject } from "react";
 export declare const Client: {
     (): import("react/jsx-runtime").JSX.Element;
     Wrapper: ({ children, theme, lang, dictionary, signals, reconnect, }: ClientWrapperProps) => import("react/jsx-runtime").JSX.Element;
-    Bridge: ({ env, lang, theme, prefix, gaTrackingId, }: ClientBridgeProps) => "" | import("react/jsx-runtime").JSX.Element | undefined;
+    Bridge: ({ env, lang, theme, prefix, gaTrackingId }: ClientBridgeProps) => "" | import("react/jsx-runtime").JSX.Element | undefined;
     Inner: () => import("react/jsx-runtime").JSX.Element;
-    SsrBridge: ({ lang, prefix, }: ClientSsrBridgeProps) => null;
+    SsrBridge: ({ lang, prefix }: ClientSsrBridgeProps) => null;
 };
 interface ClientWrapperProps {
     children: ReactNode;
@@ -37,11 +37,11 @@ interface ClientBridgeProps {
     prefix?: string;
     gaTrackingId?: string;
 }
-export declare const ClientBridge: ({ env, lang, theme, prefix, gaTrackingId, }: ClientBridgeProps) => "" | import("react/jsx-runtime").JSX.Element | undefined;
+export declare const ClientBridge: ({ env, lang, theme, prefix, gaTrackingId }: ClientBridgeProps) => "" | import("react/jsx-runtime").JSX.Element | undefined;
 export declare const ClientInner: () => import("react/jsx-runtime").JSX.Element;
 interface ClientSsrBridgeProps {
     lang: string;
     prefix?: string;
 }
-export declare const ClientSsrBridge: ({ lang, prefix, }: ClientSsrBridgeProps) => null;
+export declare const ClientSsrBridge: ({ lang, prefix }: ClientSsrBridgeProps) => null;
 export {};

package/ui/System/Client.tsx

@@ -60,8 +60,6 @@ export const ClientWrapper = ({
 
     if (typeof window !== "undefined") Translator.setActiveLocale(lang);
   }
-  if (getEnv().renderMode === "ssr") {
-  }
   useLayoutEffect(() => {
     Logger.rawLog(logo);
   }, []);
@@ -75,8 +73,7 @@ export const ClientWrapper = ({
 };
 Client.Wrapper = ClientWrapper;
 
-interface ClientPathWrapperProps
-  extends Omit<HTMLAttributes<HTMLDivElement>, "style"> {
+interface ClientPathWrapperProps extends Omit<HTMLAttributes<HTMLDivElement>, "style"> {
   bind?: () => HTMLAttributes<HTMLDivElement>;
   wrapperRef?: RefObject<HTMLDivElement | null> | null;
   pageType?: "current" | "prev" | "cached";
@@ -97,18 +94,12 @@ export const ClientPathWrapper = ({
   layoutStyle = "web",
   ...props
 }: ClientPathWrapperProps) => {
-  const href =
-    location?.href ??
-    (typeof window !== "undefined" ? window.location.href : "");
-  const hash =
-    location?.hash ??
-    (typeof window !== "undefined" ? window.location.hash : "");
+  const href = location?.href ?? (typeof window !== "undefined" ? window.location.href : "");
+  const hash = location?.hash ?? (typeof window !== "undefined" ? window.location.hash : "");
   const pathname = location?.pathname ?? "/"; 
   const params = location?.params ?? {}; 
   const searchParams = location?.searchParams ?? {}; 
-  const search =
-    location?.search ??
-    (typeof window !== "undefined" ? window.location.search : "");
+  const search = location?.search ?? (typeof window !== "undefined" ? window.location.search : "");
   const lang = params.lang;
   const firstPath = pathname.split("/")[2];
   const pathRoute: PathRoute = location?.pathRoute ?? {
@@ -141,9 +132,7 @@ export const ClientPathWrapper = ({
       }}
     >
       <animated.div
-        {...(bind && pathRoute.pageState.gesture && gestureEnabled
-          ? bind()
-          : {})}
+        {...(bind && pathRoute.pageState.gesture && gestureEnabled ? bind() : {})}
         className={clsx("group/path", className)}
         ref={wrapperRef}
         {...props}
@@ -165,13 +154,7 @@ interface ClientBridgeProps {
   gaTrackingId?: string;
 }
 
-export const ClientBridge = ({
-  env,
-  lang,
-  theme,
-  prefix,
-  gaTrackingId,
-}: ClientBridgeProps) => {
+export const ClientBridge = ({ env, lang, theme, prefix, gaTrackingId }: ClientBridgeProps) => {
   const uiOperation = st.use.uiOperation();
   const pathname = st.use.pathname();
   const params = st.use.params();
@@ -238,26 +221,18 @@ function applyThemePolicy(theme: AkanTheme): void {
   }
   if (theme === "system") {
     const dark = window.matchMedia("(prefers-color-scheme: dark)").matches;
-    document.documentElement.setAttribute(
-      "data-theme",
-      dark ? "dark" : "light",
-    );
+    document.documentElement.setAttribute("data-theme", dark ? "dark" : "light");
     return;
   }
   document.documentElement.setAttribute("data-theme", theme);
 }
 
-function buildSearchParams(
-  entries: Iterable<[string, string]>,
-): Record<string, string | string[]> {
+function buildSearchParams(entries: Iterable<[string, string]>): Record<string, string | string[]> {
   const params: Record<string, string | string[]> = {};
   for (const [key, value] of entries) {
     const current = params[key];
     if (current === undefined) params[key] = value;
-    else
-      params[key] = Array.isArray(current)
-        ? [...current, value]
-        : [current, value];
+    else params[key] = Array.isArray(current) ? [...current, value] : [current, value];
   }
   return params;
 }
@@ -277,10 +252,7 @@ interface ClientSsrBridgeProps {
   lang: string;
   prefix?: string;
 }
-export const ClientSsrBridge = ({
-  lang,
-  prefix = "",
-}: ClientSsrBridgeProps) => {
+export const ClientSsrBridge = ({ lang, prefix = "" }: ClientSsrBridgeProps) => {
   useEffect(() => {
     const visiblePrefix = getEnv().operationMode === "local" ? prefix : "";
     const navigateRscWithFallback = (
@@ -294,19 +266,13 @@ export const ClientSsrBridge = ({
         return;
       }
       void navigation.catch((error) => {
-        Logger.warn(
-          `RSC navigation failed, falling back to document navigation: ${String(error)}`,
-        );
+        Logger.warn(`RSC navigation failed, falling back to document navigation: ${String(error)}`);
         fallback();
       });
     };
     const syncHref = (href: string) => {
       const url = new URL(href, window.location.origin);
-      const { path } = getPathInfo(
-        `${url.pathname}${url.search}${url.hash}`,
-        lang,
-        visiblePrefix,
-      );
+      const { path } = getPathInfo(`${url.pathname}${url.search}${url.hash}`, lang, visiblePrefix);
       const searchParams = buildSearchParams(url.searchParams.entries());
       st.set({ pathname: url.pathname, path, searchParams });
     };
@@ -318,17 +284,11 @@ export const ClientSsrBridge = ({
       router: {
         push: (href, routeOptions) => {
           syncHref(href);
-          navigateRscWithFallback(href, routeOptions, () =>
-            window.location.assign(href),
-          );
+          navigateRscWithFallback(href, routeOptions, () => window.location.assign(href));
         },
         replace: (href, routeOptions) => {
           syncHref(href);
-          navigateRscWithFallback(
-            href,
-            { ...routeOptions, replace: true },
-            () => window.location.replace(href),
-          );
+          navigateRscWithFallback(href, { ...routeOptions, replace: true }, () => window.location.replace(href));
         },
         back: () => {
           window.history.back();
@@ -350,14 +310,8 @@ export const ClientSsrBridge = ({
     const visiblePrefix = getEnv().operationMode === "local" ? prefix : "";
     const sync = () => {
       const { pathname, search, hash } = window.location;
-      const { path } = getPathInfo(
-        `${pathname}${search}${hash}`,
-        lang,
-        visiblePrefix,
-      );
-      const searchParams = buildSearchParams(
-        new URLSearchParams(search).entries(),
-      );
+      const { path } = getPathInfo(`${pathname}${search}${hash}`, lang, visiblePrefix);
+      const searchParams = buildSearchParams(new URLSearchParams(search).entries());
       st.set({ pathname: window.location.pathname, path, searchParams });
     };
     sync();