@webda/core 4.0.0-beta.2 → 4.0.0-beta.4

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

@@ -0,0 +1,242 @@
+import { TransformCaseType } from "@webda/utils";
+import { Service } from "./service.js";
+import { Application } from "../application/application.js";
+import { OperationContext } from "../contexts/operationcontext.js";
+import type { Model, ModelClass } from "@webda/models";
+import { ServiceParameters } from "../services/serviceparameters.js";
+/**
+ * Remove Behavior-typed attributes (Metadata.Relations.behaviors) and private fields from client input.
+ * Behavior state can only be changed through the behavior's own actions.
+ * @param model - the model class
+ * @param input - the client input
+ * @returns the sanitized input
+ */
+export declare function sanitizeModelInput<T = any>(model: ModelClass<any>, input: T): T;
+/**
+ * Remove `__`-prefixed keys at any depth from client-supplied input, so private fields
+ * (such as a password hash) can never be set through the REST/operations surface
+ * @param input - the client input
+ * @returns a sanitized deep copy (non plain-object/array values are returned as is)
+ */
+export declare function stripPrivateFields<T = any>(input: T): T;
+/**
+ * Models that hold authentication state: never exposed by a DomainService (REST, GraphQL, operations), nor any of
+ * their subclasses, unless explicitly listed in its `models` parameter
+ */
+export declare const INTERNAL_MODELS: readonly string[];
+/**
+ * @param model - a model class
+ * @returns true when the model is, or descends from, one of {@link INTERNAL_MODELS}
+ */
+export declare function isInternalModel(model: any): boolean;
+/** Parameters for DomainService, controlling model exposure, URL naming, and query methods */
+export declare class DomainServiceParameters extends ServiceParameters {
+    /**
+     * Expose objects as operations too
+     *
+     * @default true
+     */
+    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;
+    /**
+     * Method used for query objects
+     *
+     * @default "PUT"
+     */
+    queryMethod?: "PUT" | "GET";
+    /**
+     * List of models to include
+     *
+     * If model is prefixed with a ! it will be excluded
+     *
+     * @default ["*"]
+     */
+    models?: string[];
+    /**
+     * Used to store the excluded models
+     * @SchemaIgnore
+     */
+    private excludedModels;
+    /**
+     * Load parameters with defaults for operations, naming, and query method
+     * @param params - the service parameters
+     * @returns this for chaining
+     */
+    load(params?: any): this;
+    /**
+     * Is a model is included in the service
+     * @param model - the model to use
+     * @returns the result
+     */
+    isIncluded(model: string): boolean;
+    /**
+     * Is a model explicitly listed (not through the wildcard) in `models`
+     * @param model - the model identifier
+     * @returns the result
+     */
+    isExplicitlyIncluded(model: string): boolean;
+    /**
+     * Is a model excluded from the service
+     * @param model - the model to use
+     * @returns the result
+     */
+    isExcluded(model: string): boolean;
+}
+export type DomainServiceEvents = {
+    "Store.WebNotFound": {
+        context: OperationContext;
+        uuid: string;
+    };
+};
+/**
+ * Domain Service expose all the models as Operations
+ *
+ * Model are exposed if they have a Expose decorator
+ *
+ * Children models Exposed should be under the first ModelRelated targetting them or the segment endpoint of Expose
+ *
+ * Other relations (ModelLinks, ModelParent) should only display their information but not be exposed
+ * ModelRelated should be ignored
+ *
+ * @WebdaModda
+ */
+export declare class DomainService<T extends DomainServiceParameters = DomainServiceParameters, E extends DomainServiceEvents = DomainServiceEvents> extends Service<T, E> {
+    app: Application;
+    static schemas: {
+        uuidRequest: {
+            type: string;
+            properties: {
+                uuid: {
+                    type: string;
+                };
+            };
+            required: string[];
+        };
+        searchRequest: {
+            type: string;
+            properties: {
+                query: {
+                    type: string;
+                };
+            };
+        };
+    };
+    /**
+     * Return the model name for this service
+     * @param name - the name to use
+     * @returns the result string
+     *
+     * @see https://blog.boot.dev/clean-code/casings-in-coding/#:~:text=%F0%9F%94%97%20Camel%20Case,Go
+     */
+    transformName(name: string): string;
+    /**
+     * Retrieve a model instance by uuid, throwing NotFound if missing or deleted
+     * @param model - the model class to query
+     * @param uuid - the primary key
+     * @returns the model instance
+     */
+    private loadModel;
+    /**
+     * Create a model operation implementation
+     * @param input - the model data to create
+     * @returns the created model instance
+     */
+    modelCreate(input: any): Promise<Model>;
+    /**
+     * Update a model operation implementation
+     * @param uuid - the model primary key
+     * @param input - the update data (may be undefined if schema was not resolvable)
+     * @returns the updated model instance
+     */
+    modelUpdate(input?: any): Promise<Model>;
+    /**
+     * Get a model operation implementation
+     * @param uuid - the model primary key
+     * @returns the model instance
+     */
+    modelGet(uuid: string): Promise<Model>;
+    /**
+     * Delete a model operation implementation
+     * @param uuid - the model primary key
+     */
+    modelDelete(uuid: string): Promise<void>;
+    /**
+     * Query models
+     * @param query - the query string
+     * @returns the query results
+     */
+    modelQuery(query: string): Promise<any>;
+    /**
+     * Patch a model
+     * @param uuid - the model primary key
+     * @param input - the partial update data (may be undefined if schema was not resolvable)
+     * @returns the patched model instance
+     */
+    modelPatch(input?: any): Promise<Model>;
+    /**
+     * Action on a model
+     * @param args - arguments forwarded to the action method
+     * @returns the action result
+     */
+    modelAction(...args: any[]): Promise<any>;
+    /**
+     * Whether a model may be exposed: models of {@link INTERNAL_MODELS} and their subclasses need an explicit listing
+     * in the `models` parameter
+     * @param model - model class
+     * @param identifier - model identifier
+     * @returns true when the model may be exposed
+     */
+    isExposable(model: any, identifier: string): boolean;
+    /**
+     * Add operations for all exposed models
+     * @returns the result
+     */
+    initOperations(): void;
+    /**
+     * Register one operation per declared action on every Behavior attribute of
+     * the model. Operation ids follow the `<Model>.<Attribute>.<Action>` shape
+     * so transports can discover them with the same lookup logic used for
+     * model-level operations.
+     *
+     * The actual dispatch is deferred to `modelBehaviorAction`. This method
+     * only wires the registry entries — it does not invoke behaviors.
+     *
+     * @param model - the model class owning the behavior attribute
+     * @param Metadata - the model metadata blob (with Relations.behaviors)
+     * @param name - the model's short identifier (e.g. "User")
+     */
+    addBehaviorOperations(model: ModelClass<Model>, Metadata: any, name: string): void;
+    /**
+     * Dispatcher for a behavior-attribute action registered by
+     * `addBehaviorOperations`. Mirrors the shape of `modelAction`:
+     *
+     *   1. read the parent model class + attribute/action names off
+     *      `operationContext` (set up by `callOperation`),
+     *   2. take `args[0]` as the parent UUID (Behavior actions are always
+     *      instance-scoped per the spec),
+     *   3. load the parent via `model.ref(uuid).get()` — `NotFound` if missing
+     *      or soft-deleted,
+     *   4. ask the model whether the action is allowed via
+     *      `canAct(ctx, "<attribute>.<action>")` — anything but `true` (or the
+     *      instance itself, the convention some models use to say "yes, on this
+     *      object") is treated as a denial,
+     *   5. read `instance[attribute]` — already a hydrated Behavior instance
+     *      thanks to `CoreModel.deserialize` (Task 7),
+     *   6. call `behaviorInstance[action](...args.slice(1))` and let
+     *      `callOperation` write the result onto the context.
+     *
+     * @param args - resolved arguments from `resolveArguments`; the first is
+     * always the parent UUID, the rest come from the request body / query
+     * params depending on the registered input schema.
+     * @returns the Behavior method's return value (callOperation writes it to
+     * the context output if non-undefined).
+     */
+    modelBehaviorAction(...args: any[]): Promise<any>;
+}
+//# sourceMappingURL=domainservice.service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"domainservice.service.d.ts","sourceRoot":"","sources":["../../src/services/domainservice.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAIvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAQrE;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAQ/E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAavD;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAA0C,CAAC;AAExF;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAOnD;AAED,8FAA8F;AAC9F,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;IAEjC;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAa3B;IAED;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,WAEvB;IAED;;;;OAIG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,WAEjC;IAED;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,WAEvB;CACF;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,mBAAmB,EAAE;QAAE,OAAO,EAAE,gBAAgB,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAClE,CAAC;AACF;;;;;;;;;;;GAWG;AACH,qBAAa,aAAa,CACxB,CAAC,SAAS,uBAAuB,GAAG,uBAAuB,EAC3D,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,CACnD,SAAQ,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACrB,GAAG,EAAE,WAAW,CAAC;IACjB,MAAM,CAAC,OAAO;QACZ,WAAW;YACT,IAAI;YACJ,UAAU;gBACR,IAAI;oBACF,IAAI;;;YAGR,QAAQ;;QAEV,aAAa;YACX,IAAI;YACJ,UAAU;gBACR,KAAK;oBACH,IAAI;;;;MAIV;IAEF;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElC;IAED;;;;;OAKG;YACW,SAAS;IAkBvB;;;;OAIG;IACG,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAkB5C;IAED;;;;;OAKG;IACG,WAAW,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CA8B7C;IAED;;;;OAIG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAM3C;IAED;;;OAGG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAO7C;IAED;;;;OAIG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAc5C;IAED;;;;;OAKG;IACG,UAAU,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CA0B5C;IAED;;;;OAIG;IACG,WAAW,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAoB9C;IAED;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAEnD;IAED;;;OAGG;IACH,cAAc,IAAI,IAAI,CAuLrB;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,QA6C1E;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,mBAAmB,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAoDtD;CACF"}