@webda/core 3.16.4 → 4.0.0-beta.2

package/lib/services/domainservice.d.ts

@@ -1,32 +1,25 @@
-import { Application, CoreModelDefinition, DeepPartial, Service, ServiceParameters, WebContext } from "../index.js";
+import { Application, BinaryFileInfo, BinaryMap, CoreModelDefinition, DeepPartial, OperationContext, Service, ServiceParameters } from "../index.js";
 import { TransformCaseType } from "../utils/case.js";
-/**
- * @WebdaModda
- */
-export declare class ModelsOperationsService extends Service {
-    /**
-     * Add operations for all exposed models
-     * @returns
-     */
-    initOperations(): void;
-}
 export declare class DomainServiceParameters extends ServiceParameters {
     /**
      * Expose objects as operations too
+     *
+     * @default true
      */
-    operations: boolean;
+    operations?: boolean;
     /**
      * Transform the name of the model to be used in the URL
      *
      * @see https://blog.boot.dev/clean-code/casings-in-coding/#:~:text=%F0%9F%94%97%20Camel%20Case,Go
+     * @default camelCase
      */
-    nameTransfomer: TransformCaseType;
+    nameTransfomer?: TransformCaseType;
     /**
      * Method used for query objects
      *
      * @default "PUT"
      */
-    queryMethod: "PUT" | "GET";
+    queryMethod?: "PUT" | "GET";
     /**
      * List of models to include
      *
@@ -34,9 +27,9 @@ export declare class DomainServiceParameters extends ServiceParameters {
      *
      * @default ["*"]
      */
-    models: string[];
+    models?: string[];
     /**
-     *
+     * Used to store the excluded models
      * @SchemaIgnore
      */
     private excludedModels;
@@ -66,6 +59,94 @@ export declare class DomainServiceParameters extends ServiceParameters {
  */
 export declare abstract class DomainService<T extends DomainServiceParameters = DomainServiceParameters> extends Service<T> {
     app: Application;
+    static schemas: {
+        uuidRequest: {
+            type: string;
+            properties: {
+                uuid: {
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        binaryGetRequest: {
+            type: string;
+            properties: {
+                uuid: {
+                    type: string;
+                };
+                index: {
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        binaryHashRequest: {
+            type: string;
+            properties: {
+                uuid: {
+                    type: string;
+                };
+                hash: {
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        binaryIndexHashRequest: {
+            type: string;
+            properties: {
+                uuid: {
+                    type: string;
+                };
+                index: {
+                    type: string;
+                };
+                hash: {
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        binaryAttachParameters: {
+            type: string;
+            properties: {
+                filename: {
+                    type: string;
+                };
+                size: {
+                    type: string;
+                };
+                mimetype: {
+                    type: string;
+                };
+                uuid: {
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        binaryChallengeRequest: {
+            type: string;
+            properties: {
+                hash: {
+                    type: string;
+                };
+                challenge: {
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        searchRequest: {
+            type: string;
+            properties: {
+                query: {
+                    type: string;
+                };
+            };
+        };
+    };
     /**
      * Load the paremeters for your service
      * @param params
@@ -101,52 +182,91 @@ export declare abstract class DomainService<T extends DomainServiceParameters =
      * Your service is now created as all the other services
      */
     resolve(): this;
-}
-/**
- *
- */
-export declare class RESTDomainServiceParameters extends DomainServiceParameters {
     /**
-     * Expose the OpenAPI
      *
-     * @default true if debug false otherwise
+     * @param model
+     * @param uuid
      */
-    exposeOpenAPI: boolean;
+    private getModel;
     /**
-     * Set default url to /
-     * @param params
+     * Create a model operation implementation
+     * @param context
      */
-    constructor(params: any);
-}
-/**
- * Expose all models via a REST API
- * @WebdaModda
- */
-export declare class RESTDomainService<T extends RESTDomainServiceParameters = RESTDomainServiceParameters> extends DomainService<T> {
+    modelCreate(context: OperationContext): Promise<void>;
     /**
-     * OpenAPI cache
+     * Update a model operation implementation
+     * @param context
      */
-    openapiContent: string;
+    modelUpdate(context: OperationContext): Promise<void>;
     /**
-     * Override to fallback on isDebug for exposeOpenAPI
-     * @returns
+     * Get a model operation implementation
+     * @param context
      */
-    resolve(): this;
+    modelGet(context: OperationContext): Promise<void>;
     /**
-     * @override
+     * Delete a model operation implementation
+     * @param context
      */
-    loadParameters(params: DeepPartial<DomainServiceParameters>): DomainServiceParameters;
+    modelDelete(context: OperationContext): Promise<void>;
     /**
-     * Handle one model and expose it based on the service
-     * @param model
-     * @param name
+     * Query models
      * @param context
+     */
+    modelQuery(context: OperationContext): Promise<void>;
+    /**
+     * Patch a model
+     * @param context
+     */
+    modelPatch(context: OperationContext): Promise<void>;
+    /**
+     * Action on a model
+     * @param context
+     */
+    modelAction(context: OperationContext): Promise<void>;
+    /**
+     * Add operations for all exposed models
      * @returns
      */
-    handleModel(model: CoreModelDefinition, name: string, context: any): boolean;
+    initOperations(): void;
+    addBinaryOperations(model: CoreModelDefinition, name: string): void;
+    /**
+     * Implement the binary challenge operation
+     * @param context
+     */
+    binaryChallenge(context: OperationContext<BinaryFileInfo & {
+        hash: string;
+        challenge: string;
+    }>): Promise<void>;
     /**
-     * Serve the openapi with the swagger-ui
-     * @param ctx
+     *
+     * @param property
+     * @param hash
+     * @returns
      */
-    openapi(ctx: WebContext): Promise<void>;
+    protected checkBinaryAlreadyLinked(property: BinaryMap | BinaryMap[], hash: string): boolean;
+    /**
+     * Set the binary content
+     * @param context
+     */
+    binaryPut(context: OperationContext): Promise<void>;
+    /**
+     * Get the binary content
+     * @param context
+     */
+    binaryGet(context: OperationContext): Promise<void>;
+    binaryAction(context: OperationContext): Promise<void>;
+}
+/**
+ * @WebdaModda
+ */
+export declare class ModelsOperationsService<T extends DomainServiceParameters> extends DomainService<T> {
+    /**
+     * Default domain
+     */
+    loadParameters(params: DeepPartial<DomainServiceParameters>): DomainServiceParameters;
+    /**
+     * Do nothing here
+     */
+    handleModel(model: CoreModelDefinition, name: string, context: any): boolean;
 }
+//# sourceMappingURL=domainservice.d.ts.map

package/lib/services/domainservice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"domainservice.d.ts","sourceRoot":"","sources":["../../src/services/domainservice.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,EAEX,cAAc,EACd,SAAS,EAKT,mBAAmB,EACnB,WAAW,EAIX,gBAAgB,EAEhB,OAAO,EACP,iBAAiB,EAGlB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAiB,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEjE,qBAAa,uBAAwB,SAAQ,iBAAiB;IAC5D;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,iBAAiB,CAAC;IACnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAC5B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;OAGG;IACH,OAAO,CAAC,cAAc,CAAW;gBAErB,MAAM,EAAE,WAAW,CAAC,uBAAuB,CAAC;IAcxD;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM;IAIxB;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM;CAGzB;AAED;;;;;;;;;GASG;AACH,8BAAsB,aAAa,CAAC,CAAC,SAAS,uBAAuB,GAAG,uBAAuB,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACjH,GAAG,EAAE,WAAW,CAAC;IACjB,MAAM,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAuFZ;IAEF;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;IAE9F;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAInC;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO;IAErF;;;;;;;OAOG;IACH,SAAS,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,EAAE,YAAY,GAAE,GAAQ;IA4B7F;;OAEG;IACH,OAAO,IAAI,IAAI;IAYf;;;;OAIG;YACW,QAAQ;IActB;;;OAGG;IACG,WAAW,CAAC,OAAO,EAAE,gBAAgB;IAiB3C;;;OAGG;IACG,WAAW,CAAC,OAAO,EAAE,gBAAgB;IAS3C;;;OAGG;IACG,QAAQ,CAAC,OAAO,EAAE,gBAAgB;IAYxC;;;OAGG;IACG,WAAW,CAAC,OAAO,EAAE,gBAAgB;IAU3C;;;OAGG;IACG,UAAU,CAAC,OAAO,EAAE,gBAAgB;IAc1C;;;OAGG;IACG,UAAU,CAAC,OAAO,EAAE,gBAAgB;IAQ1C;;;OAGG;IACG,WAAW,CAAC,OAAO,EAAE,gBAAgB;IAkB3C;;;OAGG;IACH,cAAc,IAAI,IAAI;IAmHtB,mBAAmB,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM;IA8D5D;;;OAGG;IACG,eAAe,CAAC,OAAO,EAAE,gBAAgB,CAAC,cAAc,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAyBrG;;;;;OAKG;IACH,SAAS,CAAC,wBAAwB,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO;IAO5F;;;OAGG;IACG,SAAS,CAAC,OAAO,EAAE,gBAAgB;IAoBzC;;;OAGG;IACG,SAAS,CAAC,OAAO,EAAE,gBAAgB;IAsDnC,YAAY,CAAC,OAAO,EAAE,gBAAgB;CAwC7C;AAED;;GAEG;AACH,qBAAa,uBAAuB,CAAC,CAAC,SAAS,uBAAuB,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IAC9F;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,uBAAuB,CAAC,GAAG,uBAAuB;IAIrF;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO;CAG7E"}