nicot 1.4.1 → 1.4.3

package/dist/src/decorators/property.d.ts

@@ -7,6 +7,7 @@ import { SimpleColumnType, UnsignedColumnType, WithLengthColumnType, WithPrecisi
 import { ColumnNumericOptions } from 'typeorm/decorator/options/ColumnNumericOptions';
 import { ClassOrArray, ParseType } from 'nesties';
 import { ColumnUnsignedOptions } from 'typeorm/decorator/options/ColumnUnsignedOptions';
+import { Base64BinaryStorage } from '../utility/base64-binary';
 export interface OpenAPIOptions<T> {
     description?: string;
     propertyExtras?: ApiPropertyOptions;
@@ -61,6 +62,7 @@ export declare const StringJsonColumn: <C extends ClassOrArray>(definition: C, o
 export declare const IsBase64OrBinary: (validationOptions?: ValidationOptions) => PropertyDecorator;
 export declare const Base64BinaryColumn: (options?: PropertyOptions<string> & {
     columnType?: SimpleColumnType | WithLengthColumnType;
+    binaryStorage?: Base64BinaryStorage;
 }) => PropertyDecorator;
 export declare const NotColumn: (options?: OpenAPIOptions<any>, specials?: {
     keepInCreate?: boolean;

package/dist/src/decorators/query.d.ts

@@ -1,5 +1,6 @@
 import { QueryCond } from '../bases';
 import { QueryFullTextColumnOptions } from '../utility/query-full-text-column-options.interface';
+import { Base64BinaryStorage } from '../utility/base64-binary';
 export declare const QueryCondition: (cond: QueryCond) => PropertyDecorator;
 export declare const QueryManual: () => PropertyDecorator;
 export declare class QueryWrapInfo<T = unknown> {
@@ -32,16 +33,20 @@ export declare const createQueryArrayify: (newWrapper: QueryWrapper, singleFallb
 export declare const createQueryOperatorArrayify: (operator: string, singleFallback?: string | QueryWrapper) => (field?: string) => PropertyDecorator;
 export declare const QueryIn: (field?: string) => PropertyDecorator;
 export declare const QueryNotIn: (field?: string) => PropertyDecorator;
+export interface QueryBase64Options {
+    field?: string;
+    binaryStorage?: Base64BinaryStorage;
+}
 /**
  * Builds a query condition for a `Base64BinaryColumn`. The incoming base64
- * string (the API-facing form) is decoded into a `Buffer` right before it is
- * bound as a query parameter, so it can be compared against the raw binary
- * stored in the database. A value that is already binary
- * (Buffer / Uint8Array / ArrayBuffer) is used as-is.
+ * string (the API-facing form) is decoded into a PostgreSQL-safe bytea hex
+ * parameter right before it is bound, so it can be compared against the raw
+ * binary stored in the database. A value that is already binary (Buffer /
+ * Uint8Array / ArrayBuffer) is used as that binary payload.
  */
-export declare const createQueryBase64Operator: (operator: string) => (field?: string) => PropertyDecorator;
-export declare const QueryBase64Equal: (field?: string) => PropertyDecorator;
-export declare const QueryBase64NotEqual: (field?: string) => PropertyDecorator;
+export declare const createQueryBase64Operator: (operator: string) => (fieldOrOptions?: string | QueryBase64Options) => PropertyDecorator;
+export declare const QueryBase64Equal: (fieldOrOptions?: string | QueryBase64Options) => PropertyDecorator;
+export declare const QueryBase64NotEqual: (fieldOrOptions?: string | QueryBase64Options) => PropertyDecorator;
 export declare const QueryFullText: (options?: QueryFullTextColumnOptions) => PropertyDecorator;
 export declare const QueryAnd: (...decs: PropertyDecorator[]) => PropertyDecorator;
 export declare const QueryOr: (...decs: PropertyDecorator[]) => PropertyDecorator;

package/dist/src/restful.d.ts

@@ -1,5 +1,5 @@
-import { AnyClass, ClassType } from 'nesties';
-import { OperationObject } from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';
+import type { AnyClass, ClassType } from 'nesties';
+import { ApiOperationOptions } from '@nestjs/swagger';
 import { CrudBase, CrudOptions } from './crud-base';
 import { PageSettingsDto } from './bases';
 import { CursorPaginationDto } from './dto';
@@ -21,7 +21,7 @@ export interface RestfulFactoryOptions<T, O extends keyof T = never, W extends k
     skipNonQueryableFields?: boolean;
     upsertIncludeRelations?: boolean;
 }
-export interface ResourceOptions extends Partial<OperationObject> {
+export interface ResourceOptions extends ApiOperationOptions {
     prefix?: string;
 }
 export declare class RestfulFactory<T extends {

package/dist/src/utility/base64-binary.d.ts

@@ -1,5 +1,6 @@
 import { ValueTransformer } from 'typeorm';
 export type BinaryLike = Buffer | Uint8Array | ArrayBuffer;
+export type Base64BinaryStorage = 'postgres-bytea' | 'binary';
 /**
  * Whether the value is a raw binary payload (Buffer / Uint8Array / ArrayBuffer).
  * Such values are considered "already the binary" and are accepted as-is even
@@ -7,17 +8,22 @@ export type BinaryLike = Buffer | Uint8Array | ArrayBuffer;
  */
 export declare function isBinaryLike(value: unknown): value is BinaryLike;
 export declare function binaryToBuffer(value: BinaryLike): Buffer;
+export declare function binaryToPostgresByteaHex(value: BinaryLike): string;
+export declare function base64OrBinaryToBuffer(value: string | BinaryLike): Buffer;
+export declare function base64OrBinaryToDatabaseValue(value: string | BinaryLike, storage?: Base64BinaryStorage): Buffer | string;
 /**
  * Bridges a base64 `string` on the entity/API side with raw binary storage in
  * the database.
  *
- * - `to` (entity -> DB): a base64 string is decoded into a `Buffer`. If the
- *   incoming value is already binary (Buffer / Uint8Array / ArrayBuffer) it is
- *   treated as the binary payload itself and stored directly.
+ * - `to` (entity -> DB): a base64 string is decoded into a database-safe bytea
+ *   value. If the incoming value is already binary (Buffer / Uint8Array /
+ *   ArrayBuffer) it is treated as the binary payload itself and stored directly.
  * - `from` (DB -> entity): the stored binary is encoded back into a base64
  *   string.
  */
 export declare class Base64BinaryTransformer implements ValueTransformer {
-    to(entValue: string | BinaryLike | null | undefined): Buffer | null | undefined;
-    from(dbValue: BinaryLike | null | undefined): string | null | undefined;
+    private readonly storage;
+    constructor(storage?: Base64BinaryStorage);
+    to(entValue: string | BinaryLike | null | undefined): Buffer | string | null | undefined;
+    from(dbValue: BinaryLike | string | null | undefined): string | null | undefined;
 }

package/dist/src/utility/get-api-property.d.ts

@@ -0,0 +1,3 @@
+import type { ApiPropertyOptions } from '@nestjs/swagger';
+import type { AnyClass } from 'nesties';
+export declare const getApiProperty: (cls: AnyClass, key: string) => ApiPropertyOptions;

package/dist/src/utility/patch-column-in-get.d.ts

@@ -1,2 +1,2 @@
-import { AnyClass } from 'nesties';
+import type { AnyClass } from 'nesties';
 export declare const PatchColumnsInGet: <C extends AnyClass>(cl: C, originalCl?: AnyClass, fieldsToOmit?: string[]) => C;

package/dist/src/utility/swagger-decorators.d.ts

@@ -0,0 +1,23 @@
+export interface SwaggerDecorators {
+    API_OPERATION: string;
+    API_RESPONSE: string;
+    API_PRODUCES: string;
+    API_CONSUMES: string;
+    API_TAGS: string;
+    API_WEBHOOK: string;
+    API_CALLBACKS: string;
+    API_PARAMETERS: string;
+    API_HEADERS: string;
+    API_MODEL_PROPERTIES: string;
+    API_MODEL_PROPERTIES_ARRAY: string;
+    API_SECURITY: string;
+    API_EXCLUDE_ENDPOINT: string;
+    API_INCLUDE_ENDPOINT: string;
+    API_EXCLUDE_CONTROLLER: string;
+    API_EXTRA_MODELS: string;
+    API_EXTENSION: string;
+    API_SCHEMA: string;
+    API_DEFAULT_GETTER: string;
+    API_LINK: string;
+}
+export declare const DECORATORS: SwaggerDecorators;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nicot",
   "description": "Nest.js interacting with class-validator + OpenAPI + TypeORM for Nest.js Restful API development.",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -68,6 +68,7 @@
   "devDependencies": {
     "@nestjs/core": "^11.0.14",
     "@nestjs/platform-express": "^11.0.14",
+    "@nestjs/swagger": "^11.4.4",
     "@nestjs/testing": "^11.0.14",
     "@nestjs/typeorm": "^11.0.1",
     "@types/jest": "^29.5.14",
@@ -103,7 +104,7 @@
   },
   "dependencies": {
     "lodash": "^4.17.21",
-    "nesties": "^1.1.33",
+    "nesties": "^1.1.34",
     "nfkit": "^1.0.13",
     "p-queue": "6.6.2",
     "reflect-metadata": "^0.2.2",