@ai0x0/utils 0.0.50 → 0.1.0

package/es/backend/route-operation/read-operation-core.d.ts

@@ -2,15 +2,14 @@ import { NextRequest } from "next/server";
 import { TypedNextRequest } from "next-rest-framework";
 import { z, ZodSchema } from "zod";
 import { type RouteOpenApiOperation } from "./open-api-operation.js";
-import { ActionFactory, GetOperationParams, RouteCatch, SessionGetter } from "./operation-common.js";
-export interface GetOperationOptions<T extends ZodSchema, Q extends ZodSchema, TTable, TRelations> {
+import { AccessOptions, ActionFactory, DefaultSession, GetOperationParams, RouteCatch, SessionGetter } from "./operation-common.js";
+import { ScopeArg } from "../scope.js";
+export interface GetOperationOptions<T extends ZodSchema, Q extends ZodSchema, TTable, TRelations, TSession = DefaultSession> {
     schemas: {
         query: Q;
         response: T;
     };
-    access?: {
-        byCreator?: boolean;
-    };
+    access?: AccessOptions<TSession>;
     jsonArrayFields?: string[];
     relations?: TRelations;
     setParams?: (_req: TypedNextRequest<"GET", "application/json", unknown, z.infer<Q>>) => Promise<Record<string, unknown>>;
@@ -24,13 +23,15 @@ export interface GetOperationOptions<T extends ZodSchema, Q extends ZodSchema, T
     table?: TTable;
 }
 export declare function createGetOperationFactory<TTable, TRelations>({ createAction, getTableName, }: {
-    createAction: ActionFactory<TTable, (_params: Record<string, unknown>) => Promise<unknown | undefined>>;
+    createAction: ActionFactory<TTable, (_params: Record<string, unknown>, _options: {
+        scope: ScopeArg;
+    }) => Promise<unknown | undefined>>;
     getTableName(table: TTable): string;
-}): ({ db, getSession }: {
+}): <TSession = DefaultSession>({ db, getSession, }: {
     db?: unknown;
-    getSession: SessionGetter;
-}) => <T extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, Q extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>({ schemas, access, table, openApiOperation, relations, setParams, jsonArrayFields, handler, catch: catchHandler, }: GetOperationOptions<T, Q, TTable, TRelations>) => import("next-rest-framework").RouteOperationDefinition<"GET">;
-export interface GetListOperationOptions<T extends ZodSchema, Q extends ZodSchema, TTable, TRelations> extends Omit<GetOperationOptions<T, Q, TTable, TRelations>, "handler"> {
+    getSession: SessionGetter<TSession>;
+}) => <T extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, Q extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>({ schemas, access, table, openApiOperation, relations, setParams, jsonArrayFields, handler, catch: catchHandler, }: GetOperationOptions<T, Q, TTable, TRelations, TSession>) => import("next-rest-framework").RouteOperationDefinition<"GET">;
+export interface GetListOperationOptions<T extends ZodSchema, Q extends ZodSchema, TTable, TRelations, TSession = DefaultSession> extends Omit<GetOperationOptions<T, Q, TTable, TRelations, TSession>, "handler"> {
     handler?: <D extends T>(_payload: {
         params: GetOperationParams<Q>;
         data: {
@@ -44,12 +45,14 @@ export interface GetListOperationOptions<T extends ZodSchema, Q extends ZodSchem
     }>;
 }
 export declare function createGetListOperationFactory<TTable, TRelations>({ createAction, getTableName, }: {
-    createAction: ActionFactory<TTable, (_params: Record<string, unknown>) => Promise<{
+    createAction: ActionFactory<TTable, (_params: Record<string, unknown>, _options: {
+        scope: ScopeArg;
+    }) => Promise<{
         data: unknown[];
         total: number;
     }>>;
     getTableName(table: TTable): string;
-}): ({ db, getSession }: {
+}): <TSession = DefaultSession>({ db, getSession, }: {
     db?: unknown;
-    getSession: SessionGetter;
-}) => <T extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, Q extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>({ schemas, access, table, openApiOperation, relations, jsonArrayFields, setParams, handler, catch: catchHandler, }: GetListOperationOptions<T, Q, TTable, TRelations>) => import("next-rest-framework").RouteOperationDefinition<"GET">;
+    getSession: SessionGetter<TSession>;
+}) => <T extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, Q extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>({ schemas, access, table, openApiOperation, relations, jsonArrayFields, setParams, handler, catch: catchHandler, }: GetListOperationOptions<T, Q, TTable, TRelations, TSession>) => import("next-rest-framework").RouteOperationDefinition<"GET">;

package/es/backend/route-operation/read-operation-core.js

@@ -44,7 +44,7 @@ export function createGetOperationFactory(_ref) {
         status: 200
       }]).handler( /*#__PURE__*/function () {
         var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(req) {
-          var mergedParams, rawResult, result;
+          var _yield$getReadParams, mergedParams, scope, rawResult, result;
           return _regeneratorRuntime().wrap(function _callee$(_context) {
             while (1) switch (_context.prev = _context.next) {
               case 0:
@@ -58,53 +58,57 @@ export function createGetOperationFactory(_ref) {
                   setParams: setParams
                 });
               case 3:
-                mergedParams = _context.sent;
+                _yield$getReadParams = _context.sent;
+                mergedParams = _yield$getReadParams.params;
+                scope = _yield$getReadParams.scope;
                 if (!(table && db)) {
-                  _context.next = 10;
+                  _context.next = 12;
                   break;
                 }
-                _context.next = 7;
+                _context.next = 9;
                 return createAction({
                   bodySchema: schemas.response,
                   db: db,
                   jsonArrayFields: jsonArrayFields,
                   relations: relations,
                   table: table
-                })(mergedParams);
-              case 7:
+                })(mergedParams, {
+                  scope: scope
+                });
+              case 9:
                 _context.t0 = _context.sent;
-                _context.next = 11;
+                _context.next = 13;
                 break;
-              case 10:
+              case 12:
                 _context.t0 = mergedParams;
-              case 11:
+              case 13:
                 rawResult = _context.t0;
                 result = rawResult !== null && rawResult !== void 0 ? rawResult : {};
                 if (!handler) {
-                  _context.next = 17;
+                  _context.next = 19;
                   break;
                 }
-                _context.next = 16;
+                _context.next = 18;
                 return handler({
                   data: result,
                   params: mergedParams,
                   req: req
                 });
-              case 16:
+              case 18:
                 result = _context.sent;
-              case 17:
+              case 19:
                 return _context.abrupt("return", TypedNextResponse.json(result, {
                   status: 200
                 }));
-              case 20:
-                _context.prev = 20;
+              case 22:
+                _context.prev = 22;
                 _context.t1 = _context["catch"](0);
                 return _context.abrupt("return", handleOperationError(_context.t1, catchHandler));
-              case 23:
+              case 25:
               case "end":
                 return _context.stop();
             }
-          }, _callee, null, [[0, 20]]);
+          }, _callee, null, [[0, 22]]);
         }));
         return function (_x) {
           return _ref4.apply(this, arguments);
@@ -151,7 +155,7 @@ export function createGetListOperationFactory(_ref5) {
         status: 200
       }]).handler( /*#__PURE__*/function () {
         var _ref8 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(req) {
-          var mergedParams, result;
+          var _yield$getReadParams2, mergedParams, scope, result;
           return _regeneratorRuntime().wrap(function _callee2$(_context2) {
             while (1) switch (_context2.prev = _context2.next) {
               case 0:
@@ -165,55 +169,59 @@ export function createGetListOperationFactory(_ref5) {
                   setParams: setParams
                 });
               case 3:
-                mergedParams = _context2.sent;
+                _yield$getReadParams2 = _context2.sent;
+                mergedParams = _yield$getReadParams2.params;
+                scope = _yield$getReadParams2.scope;
                 if (!(table && db)) {
-                  _context2.next = 10;
+                  _context2.next = 12;
                   break;
                 }
-                _context2.next = 7;
+                _context2.next = 9;
                 return createAction({
                   bodySchema: schemas.response,
                   db: db,
                   jsonArrayFields: jsonArrayFields,
                   relations: relations,
                   table: table
-                })(mergedParams);
-              case 7:
+                })(mergedParams, {
+                  scope: scope
+                });
+              case 9:
                 _context2.t0 = _context2.sent;
-                _context2.next = 11;
+                _context2.next = 13;
                 break;
-              case 10:
+              case 12:
                 _context2.t0 = {
                   data: [],
                   total: 0
                 };
-              case 11:
+              case 13:
                 result = _context2.t0;
                 if (!handler) {
-                  _context2.next = 16;
+                  _context2.next = 18;
                   break;
                 }
-                _context2.next = 15;
+                _context2.next = 17;
                 return handler({
                   data: result,
                   params: mergedParams,
                   req: req
                 });
-              case 15:
+              case 17:
                 result = _context2.sent;
-              case 16:
+              case 18:
                 return _context2.abrupt("return", TypedNextResponse.json(result, {
                   status: 200
                 }));
-              case 19:
-                _context2.prev = 19;
+              case 21:
+                _context2.prev = 21;
                 _context2.t1 = _context2["catch"](0);
                 return _context2.abrupt("return", handleOperationError(_context2.t1, catchHandler));
-              case 22:
+              case 24:
               case "end":
                 return _context2.stop();
             }
-          }, _callee2, null, [[0, 19]]);
+          }, _callee2, null, [[0, 21]]);
         }));
         return function (_x2) {
           return _ref8.apply(this, arguments);

package/es/backend/route-operation/write-operation-core.d.ts

@@ -2,15 +2,21 @@ import { NextRequest } from "next/server";
 import { TypedNextRequest } from "next-rest-framework";
 import { z, ZodSchema } from "zod";
 import { type RouteOpenApiOperation } from "./open-api-operation.js";
-import { ActionFactory, RouteCatch, SessionGetter } from "./operation-common.js";
+import { AccessOptions, ActionFactory, DefaultSession, RouteCatch, SessionGetter } from "./operation-common.js";
+import { ScopeArg } from "../scope.js";
 export type PostOperationParams<IB extends ZodSchema> = z.infer<IB> & Record<string, unknown> & {
     creatorId?: string;
 };
-export interface PostOperationOptions<IB extends ZodSchema, OB extends ZodSchema, TTable> {
+export interface PostOperationOptions<IB extends ZodSchema, OB extends ZodSchema, TTable, TSession = DefaultSession> {
     schemas: {
         body: IB;
         response?: OB;
     };
+    /**
+     * 新建时把归属列盖成这次请求的作用域值（默认就是 creatorId = 当前用户）。
+     * can 同样生效 —— 只读角色不能新建。
+     */
+    access?: AccessOptions<TSession>;
     contentType?: string;
     openApiOperation?: RouteOpenApiOperation;
     parseBody?: (_req: NextRequest) => Promise<Record<string, unknown>>;
@@ -26,21 +32,19 @@ export interface PostOperationOptions<IB extends ZodSchema, OB extends ZodSchema
 export declare function createPostOperationFactory<TTable>({ createAction, getTableName, }: {
     createAction: ActionFactory<TTable, (_body: Record<string, unknown>) => Promise<unknown[]>>;
     getTableName(table: TTable): string;
-}): ({ db, getSession }: {
+}): <TSession = DefaultSession>({ db, getSession, }: {
     db?: unknown;
-    getSession: SessionGetter;
-}) => <IB extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, OB extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>({ schemas, contentType, openApiOperation, parseBody, setBody, table, handler, catch: catchHandler, }: PostOperationOptions<IB, OB, TTable>) => import("next-rest-framework").RouteOperationDefinition<"POST">;
+    getSession: SessionGetter<TSession>;
+}) => <IB extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, OB extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>({ schemas, access, contentType, openApiOperation, parseBody, setBody, table, handler, catch: catchHandler, }: PostOperationOptions<IB, OB, TTable, TSession>) => import("next-rest-framework").RouteOperationDefinition<"POST">;
 export type PutOperationParams<IB extends ZodSchema> = z.infer<IB> & Record<string, unknown> & {
     editorId?: string;
 };
-export interface PutOperationOptions<IB extends ZodSchema, OB extends ZodSchema, TTable> {
+export interface PutOperationOptions<IB extends ZodSchema, OB extends ZodSchema, TTable, TSession = DefaultSession> {
     schemas: {
         body: IB;
         response?: OB;
     };
-    access?: {
-        byCreator?: boolean;
-    };
+    access?: AccessOptions<TSession>;
     openApiOperation?: RouteOpenApiOperation;
     table?: TTable;
     setBody?: (_req: TypedNextRequest<"PUT", "application/json", z.infer<IB>>) => Promise<Partial<z.infer<IB>>>;
@@ -52,26 +56,24 @@ export interface PutOperationOptions<IB extends ZodSchema, OB extends ZodSchema,
     catch?: RouteCatch;
 }
 export declare function createPutOperationFactory<TTable>({ createAction, getTableName, }: {
-    createAction: ActionFactory<TTable, (_body: Record<string, unknown>, _options?: {
-        byCreator?: boolean;
+    createAction: ActionFactory<TTable, (_body: Record<string, unknown>, _options: {
+        scope: ScopeArg;
     }) => Promise<unknown>>;
     getTableName(table: TTable): string;
-}): ({ db, getSession }: {
+}): <TSession = DefaultSession>({ db, getSession, }: {
     db?: unknown;
-    getSession: SessionGetter;
-}) => <IB extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, OB extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>({ schemas, access, openApiOperation, table, setBody, handler, catch: catchHandler, }: PutOperationOptions<IB, OB, TTable>) => import("next-rest-framework").RouteOperationDefinition<"PUT">;
+    getSession: SessionGetter<TSession>;
+}) => <IB extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, OB extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>({ schemas, access, openApiOperation, table, setBody, handler, catch: catchHandler, }: PutOperationOptions<IB, OB, TTable, TSession>) => import("next-rest-framework").RouteOperationDefinition<"PUT">;
 export type DeleteOperationParams<B extends ZodSchema> = z.infer<B> & Record<string, unknown> & {
     creatorId?: string;
     id: string;
 };
-export interface DeleteOperationOptions<TTable, B extends ZodSchema> {
+export interface DeleteOperationOptions<TTable, B extends ZodSchema, TSession = DefaultSession> {
     table?: TTable;
     schemas?: {
         body?: B;
     };
-    access?: {
-        byCreator?: boolean;
-    };
+    access?: AccessOptions<TSession>;
     openApiOperation?: RouteOpenApiOperation;
     handler?: (_payload: {
         params: DeleteOperationParams<B>;
@@ -83,12 +85,13 @@ export interface DeleteOperationOptions<TTable, B extends ZodSchema> {
 export declare function createDeleteOperationFactory<TTable>({ createAction, getTableName, }: {
     createAction: ActionFactory<TTable, (_params: {
         id: string;
-        creatorId?: string;
+    }, _options: {
+        scope: ScopeArg;
     }) => Promise<unknown>>;
     getTableName(table: TTable): string;
-}): ({ db, getSession }: {
+}): <TSession = DefaultSession>({ db, getSession, }: {
     db?: unknown;
-    getSession: SessionGetter;
+    getSession: SessionGetter<TSession>;
 }) => <B extends z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>> = z.ZodObject<{
     id: z.ZodString;
-}, z.core.$strip>>({ table, schemas, access, openApiOperation, handler, catch: catchHandler, }: DeleteOperationOptions<TTable, B>) => import("next-rest-framework").RouteOperationDefinition<"DELETE">;
+}, z.core.$strip>>({ table, schemas, access, openApiOperation, handler, catch: catchHandler, }: DeleteOperationOptions<TTable, B, TSession>) => import("next-rest-framework").RouteOperationDefinition<"DELETE">;