akanjs 3.1.1-rc.4 → 3.1.1-rc.5

package/document/by.ts

@@ -1,6 +1,7 @@
 import { type Cls, FIELD_META, type GetActionObject } from "akanjs/base";
 import { applyMixins } from "akanjs/common";
 import { ConstantRegistry, type DocumentConstantModelRef, type DocumentModel, type FieldObject } from "akanjs/constant";
+import type { DocumentTouchOptions } from "./documentQuery";
 
 export type DatabaseCls<Schema = unknown> = Cls<Schema, { refName: string; [FIELD_META]: FieldObject }>;
 export type DatabaseInstanceOf<DatabaseRef extends DatabaseCls> = DatabaseRef extends new (
@@ -14,7 +15,7 @@ export interface DefaultDocMtds<TDocument> {
   refresh(): Promise<this>;
   isModified(field?: keyof TDocument & string): boolean;
   set(data: Partial<TDocument>): this;
-  save(): Promise<this>;
+  save(options?: DocumentTouchOptions): Promise<this>;
   toJSON(): DocumentModel<TDocument>;
   toObject(): DocumentModel<TDocument>;
 }
@@ -25,7 +26,7 @@ type HydratedDocumentMethods<TDocument, Self> = Omit<
   refresh(): Promise<Self>;
   isModified(field?: keyof TDocument & string): boolean;
   set(data: Partial<TDocument>): Self;
-  save(): Promise<Self>;
+  save(options?: DocumentTouchOptions): Promise<Self>;
 };
 type HydratedDocumentWithId<TDocument> = TDocument & { id: string } & HydratedDocumentMethods<TDocument, TDocument>;
 interface ChainableHydratedMethods<TDocument>
@@ -33,7 +34,7 @@ interface ChainableHydratedMethods<TDocument>
   refresh(): Promise<this>;
   isModified(field?: keyof TDocument & string): boolean;
   set(data: Partial<TDocument>): this;
-  save(): Promise<this>;
+  save(options?: DocumentTouchOptions): Promise<this>;
 }
 type ChainableHydratedDocument<TDocument> = TDocument & {
   id: string;

package/document/into.ts

@@ -25,8 +25,8 @@ interface DefaultMdlStats<
   _FilterQuery extends DocumentQuery<TSchema> = DocumentQuery<TSchema>,
   _Projection = DocumentProjection<TSchema>,
 > {
-  pickOneAndWrite: (query: _FilterQuery, rawData: _Partial) => Promise<TDocument>;
-  pickAndWrite: (docId: string, rawData: _Partial) => Promise<TDocument>;
+  pickOneAndWrite: (query: _FilterQuery, rawData: _Partial, options?: DocumentTouchOptions) => Promise<TDocument>;
+  pickAndWrite: (docId: string, rawData: _Partial, options?: DocumentTouchOptions) => Promise<TDocument>;
   pickOne: (query: _FilterQuery, projection?: _Projection) => Promise<TDocument>;
   pickById: (docId: string | undefined, projection?: _Projection) => Promise<TDocument>;
   sample: (query: _FilterQuery, size?: number) => Promise<TDocument[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "akanjs",
-  "version": "3.1.1-rc.4",
+  "version": "3.1.1-rc.5",
   "sourceType": "module",
   "type": "module",
   "publishConfig": {

package/server/akanApp.ts

@@ -24,6 +24,7 @@ import type { OpsRoute } from "./ops/opsRoute";
 import { StatusAccess } from "./ops/statusAccess";
 import { ProcessMetricsCollector } from "./processMetricsCollector";
 import { HostAllowlist } from "./routing/hostAllowlist";
+import { WsUpgrade } from "./routing/wsUpgrade";
 import { SelfExec } from "./selfExec";
 import { resolveStaticPath } from "./staticPath";
 import { getWebConfigFromEnv } from "./types";
@@ -670,6 +671,7 @@ export class AkanApp {
     } catch {
       return new Response("Forbidden", { status: 403 });
     }
+    if (!WsUpgrade.isRequested(req)) return WsUpgrade.required();
     const upstreamWs = new WebSocket(`ws://${upstream.host}:${upstream.port}${url.pathname}${url.search}`, {
       headers: makeAkanChildProxyHeaders(req, child.idx, server.requestIP(req)),
     } as unknown as string[]);

package/server/resolver/database.resolver.ts

@@ -278,9 +278,10 @@ export class DatabaseResolver {
             timedQuery(() => store.pickOne(query, { select: projection })),
           pickById,
           
-          pickAndWrite: async (id: string, rawData: any) => await (await pickById(id)).set(rawData).save(),
-          pickOneAndWrite: async (query: QueryOf<any>, rawData: any) =>
-            await (await timedQuery(() => store.pickOne(query))).set(rawData).save(),
+          pickAndWrite: async (id: string, rawData: any, options?: DocumentTouchOptions) =>
+            await (await pickById(id)).set(rawData).save(...touchArgs(options)),
+          pickOneAndWrite: async (query: QueryOf<any>, rawData: any, options?: DocumentTouchOptions) =>
+            await (await timedQuery(() => store.pickOne(query))).set(rawData).save(...touchArgs(options)),
           exists: async (query: QueryOf<any>, options?: DocumentScopeOptions) =>
             await timedQuery(() => store.exists(query, ...scopeArgs(options))),
           sample: (query: QueryOf<any>, size = 1) => timedQuery(() => store.find(query, { sample: size, limit: size })),

package/server/routing/apiRouter.ts

@@ -15,6 +15,7 @@ import { SignalResolver } from "../resolver";
 import type { HttpRoutes, SignalRouteOptions, WebsocketRoutes } from "../types";
 import { AppWsData } from "./appWsData";
 import type { HostAllowlist } from "./hostAllowlist";
+import { WsUpgrade } from "./wsUpgrade";
 
 export interface HmrStateSource {
   readonly state: {
@@ -93,6 +94,7 @@ export class ApiRouter {
         }
         const upgraded = upgradeAppWs(req, AppWsData.fromRequest(req));
         if (upgraded) return;
+        if (!WsUpgrade.isRequested(req)) return WsUpgrade.required();
         return new Response("Failed to upgrade to WebSocket", { status: 500 });
       },
       ...Object.fromEntries(endpointEntries),

package/server/routing/wsUpgrade.ts

@@ -0,0 +1,10 @@
+
+export class WsUpgrade {
+  static isRequested(req: Request) {
+    return req.headers.get("upgrade")?.toLowerCase() === "websocket";
+  }
+
+  static required() {
+    return new Response("Upgrade Required", { status: 426, headers: { Upgrade: "websocket", Connection: "Upgrade" } });
+  }
+}

package/service/predefinedAdaptor/sql/SqlDocumentStore.ts

@@ -412,7 +412,7 @@ export class SqlDocumentStore {
 
   async update(id: string, patch: DocumentRecord, options: WriteHookOptions = {}) {
     const current = await this.pickByIdForWrite(id);
-    return await this.writeUpdatedDocument(id, { ...current, ...patch, id, updatedAt: dayjs() }, current, options);
+    return await this.writeUpdatedDocument(id, { ...current, ...patch, id }, current, options);
   }
 
   async remove(id: string) {
@@ -957,9 +957,9 @@ export class SqlDocumentStore {
     id: string,
     data: DocumentRecord,
     originalData: DocumentRecord,
-    { runSaveHooks = true, crudType = "update" }: WriteHookOptions = {},
+    { runSaveHooks = true, crudType = "update", touch = true }: WriteHookOptions = {},
   ) {
-    const prepared = this.prepareDocument({ ...data, id, updatedAt: dayjs() });
+    const prepared = this.prepareDocument({ ...data, id, updatedAt: touch ? dayjs() : originalData.updatedAt });
     this.#assertImmutableUnchanged(prepared, originalData);
     const doc = this.hydrate(prepared, originalData);
     
@@ -968,7 +968,7 @@ export class SqlDocumentStore {
     await this.runHooks(crudType, crudType, doc, "pre", previous);
     const row = this.toRow(doc);
     const stored = (originalData as Record<symbol, StoredRow | undefined>)[SqlDocumentStore.#storedRow];
-    await this.#writeChanges(id, stored ?? this.toRow(originalData), row);
+    await this.#writeChanges(id, stored ?? this.toRow(originalData), row, touch);
     await this.runHooks(crudType, crudType, doc, "post", previous);
     if (runSaveHooks) await this.runHooks("save", crudType, doc, "post", previous);
     return this.#withStoredRow(doc, row);
@@ -978,11 +978,12 @@ export class SqlDocumentStore {
    * Merges only the fields that changed into the stored `_doc`, so a concurrent write to another field survives. A key
    * the stored row lacks is written out, which is what `q.missing` tells rows from before a field existed apart by.
    */
-  async #writeChanges(id: string, read: StoredRow, written: StoredRow) {
+  async #writeChanges(id: string, read: StoredRow, written: StoredRow, touch: boolean) {
     const before = SqlDocumentStore.#encodedFields(read);
     const after = SqlDocumentStore.#encodedFields(written);
-    const assignments = [`"updatedAt" = ?`];
-    const params: unknown[] = [written.updatedAt];
+    
+    const assignments = [touch ? `"updatedAt" = ?` : `"updatedAt" = "updatedAt"`];
+    const params: unknown[] = touch ? [written.updatedAt] : [];
     for (const column of ["createdAt", "removedAt"] as const) {
       if (before.get(column) === after.get(column)) continue;
       assignments.push(`${quoteIdent(column)} = ?`);
@@ -1201,10 +1202,10 @@ export class SqlDocumentStore {
         },
       },
       save: {
-        async value(this: DocumentRecord) {
+        async value(this: DocumentRecord, { touch }: DocumentTouchOptions = {}) {
           if (!this.id) return store.create(this);
           store.#assertLiveRow(this);
-          return store.update(this.id as string, store.#changesOf(this));
+          return store.update(this.id as string, store.#changesOf(this), touch === false ? { touch } : {});
         },
       },
       refresh: {

package/service/predefinedAdaptor/sql/types.ts

@@ -170,7 +170,7 @@ export type FindOneOptions = DocumentScopeOptions & {
   select?: ProjectionOption;
 };
 export type FindIdOptions = DocumentScopeOptions & { sort?: SortOption; skip?: number | null; sample?: boolean };
-export type WriteHookOptions = { runSaveHooks?: boolean; crudType?: "update" | "remove" };
+export type WriteHookOptions = DocumentTouchOptions & { runSaveHooks?: boolean; crudType?: "update" | "remove" };
 export type QueryOperatorName = Extract<DocumentQueryNode, { kind: "op" }>["op"];
 export interface SqliteDocumentRow {
   id: string;

package/types/document/by.d.ts

@@ -1,5 +1,6 @@
 import { type Cls, FIELD_META, type GetActionObject } from "akanjs/base";
 import { type DocumentConstantModelRef, type DocumentModel, type FieldObject } from "akanjs/constant";
+import type { DocumentTouchOptions } from "./documentQuery.d.ts";
 export type DatabaseCls<Schema = unknown> = Cls<Schema, {
     refName: string;
     [FIELD_META]: FieldObject;
@@ -10,7 +11,7 @@ export interface DefaultDocMtds<TDocument> {
     refresh(): Promise<this>;
     isModified(field?: keyof TDocument & string): boolean;
     set(data: Partial<TDocument>): this;
-    save(): Promise<this>;
+    save(options?: DocumentTouchOptions): Promise<this>;
     toJSON(): DocumentModel<TDocument>;
     toObject(): DocumentModel<TDocument>;
 }
@@ -18,7 +19,7 @@ type HydratedDocumentMethods<TDocument, Self> = Omit<DefaultDocMtds<TDocument>,
     refresh(): Promise<Self>;
     isModified(field?: keyof TDocument & string): boolean;
     set(data: Partial<TDocument>): Self;
-    save(): Promise<Self>;
+    save(options?: DocumentTouchOptions): Promise<Self>;
 };
 type HydratedDocumentWithId<TDocument> = TDocument & {
     id: string;
@@ -27,7 +28,7 @@ interface ChainableHydratedMethods<TDocument> extends Omit<DefaultDocMtds<TDocum
     refresh(): Promise<this>;
     isModified(field?: keyof TDocument & string): boolean;
     set(data: Partial<TDocument>): this;
-    save(): Promise<this>;
+    save(options?: DocumentTouchOptions): Promise<this>;
 }
 type ChainableHydratedDocument<TDocument> = TDocument & {
     id: string;

package/types/document/into.d.ts

@@ -10,8 +10,8 @@ export type CRUDEventType = "create" | "update" | "remove";
 export type SaveEventType = "save" | CRUDEventType;
 export type SaveEventListener<Doc> = (doc: Doc, type: CRUDEventType, previous?: Doc) => PromiseOrObject<void>;
 interface DefaultMdlStats<TDocument, TSchema, _Partial extends Partial<TSchema> = Partial<TSchema>, _FilterQuery extends DocumentQuery<TSchema> = DocumentQuery<TSchema>, _Projection = DocumentProjection<TSchema>> {
-    pickOneAndWrite: (query: _FilterQuery, rawData: _Partial) => Promise<TDocument>;
-    pickAndWrite: (docId: string, rawData: _Partial) => Promise<TDocument>;
+    pickOneAndWrite: (query: _FilterQuery, rawData: _Partial, options?: DocumentTouchOptions) => Promise<TDocument>;
+    pickAndWrite: (docId: string, rawData: _Partial, options?: DocumentTouchOptions) => Promise<TDocument>;
     pickOne: (query: _FilterQuery, projection?: _Projection) => Promise<TDocument>;
     pickById: (docId: string | undefined, projection?: _Projection) => Promise<TDocument>;
     sample: (query: _FilterQuery, size?: number) => Promise<TDocument[]>;

package/types/server/routing/wsUpgrade.d.ts

@@ -0,0 +1,4 @@
+export declare class WsUpgrade {
+    static isRequested(req: Request): boolean;
+    static required(): Response;
+}

package/types/service/predefinedAdaptor/sql/types.d.ts

@@ -170,7 +170,7 @@ export type FindIdOptions = DocumentScopeOptions & {
     skip?: number | null;
     sample?: boolean;
 };
-export type WriteHookOptions = {
+export type WriteHookOptions = DocumentTouchOptions & {
     runSaveHooks?: boolean;
     crudType?: "update" | "remove";
 };