@webda/core 2.4.2 → 3.0.0

package/lib/stores/store.d.ts

@@ -1,14 +1,14 @@
-import { Counter, EventWithContext, Histogram, WebdaError } from "../core.js";
-import { ConfigurationProvider } from "../index.js";
-import { Constructor, CoreModel, CoreModelDefinition } from "../models/coremodel.js";
+import { Counter, EventWithContext, Histogram } from "../core.js";
+import { ConfigurationProvider, WebdaError } from "../index.js";
+import { Constructor, CoreModel, CoreModelDefinition, FilterKeys } from "../models/coremodel.js";
 import { Service, ServiceParameters } from "../services/service.js";
-import { Context, OperationContext } from "../utils/context.js";
+import { OperationContext, WebContext } from "../utils/context.js";
 import { HttpMethodType } from "../utils/httpcontext.js";
 import { WebdaQL } from "./webdaql/query.js";
-export declare class StoreNotFoundError extends WebdaError {
+export declare class StoreNotFoundError extends WebdaError.CodeError {
     constructor(uuid: string, storeName: string);
 }
-export declare class UpdateConditionFailError extends WebdaError {
+export declare class UpdateConditionFailError extends WebdaError.CodeError {
     constructor(uuid: string, conditionField: string, condition: string | Date);
 }
 interface EventStore {
@@ -20,6 +20,10 @@ interface EventStore {
      * Store emitting
      */
     store: Store;
+    /**
+     * Context of the operation
+     */
+    context?: OperationContext;
 }
 /**
  * Event called before save of an object
@@ -58,6 +62,10 @@ export interface EventStoreAction extends EventWithContext {
      * Target object unless it is a global action
      */
     object?: CoreModel;
+    /**
+     * Model of the object if global action
+     */
+    model?: CoreModelDefinition;
     /**
      * Emitting store
      */
@@ -99,7 +107,7 @@ export interface EventStorePatchUpdated extends EventStoreUpdated {
 /**
  * Event called after partial update of an object
  */
-export interface EventStorePartialUpdated {
+export interface EventStorePartialUpdated<T extends CoreModel = CoreModel> {
     /**
      * Object uuid
      */
@@ -107,7 +115,7 @@ export interface EventStorePartialUpdated {
     /**
      * Emitting store
      */
-    store: Store;
+    store: Store<T>;
     /**
      * Update date
      */
@@ -119,7 +127,7 @@ export interface EventStorePartialUpdated {
         /**
          * If incremental update
          */
-        increment?: {
+        increments?: {
             /**
              * Increment value
              */
@@ -128,7 +136,7 @@ export interface EventStorePartialUpdated {
              * Property to increment
              */
             property: string;
-        };
+        }[];
         /**
          * Add item to a collection
          */
@@ -178,6 +186,10 @@ export interface EventStoreQuery {
      * The parsed query by our grammar
      */
     parsedQuery: WebdaQL.Query;
+    /**
+     * Context in which the query was run
+     */
+    context: OperationContext;
 }
 /**
  * Event sent when query is resolved
@@ -269,7 +281,11 @@ export interface EventStoreWebDelete extends EventWithContext {
      */
     store: Store;
 }
-export type ExposeParameters = {
+/**
+ * @deprecated Store should not be exposed directly anymore
+ * You should use the DomainService instead
+ */
+export type StoreExposeParameters = {
     /**
      * URL endpoint to use to expose REST Resources API
      *
@@ -342,18 +358,16 @@ export declare class StoreParameters extends ServiceParameters {
      * @default "Webda/CoreModel"
      */
     model?: string;
-    /**
-     * Different models managed by this store
-     */
-    models?: string[];
     /**
      * async delete
      */
     asyncDelete: boolean;
     /**
      * Expose the service to an urls
+     *
+     * @deprecated will probably be removed in 4.0 in favor of Expose annotation
      */
-    expose?: ExposeParameters;
+    expose?: StoreExposeParameters;
     /**
      * Allow to load object that does not have the type data
      *
@@ -383,20 +397,11 @@ export declare class StoreParameters extends ServiceParameters {
      */
     slowQueryThreshold: number;
     /**
-     * Parent of the store
-     *
-     * If parent is specified the url route is relative to it
+     * Model Aliases to allow easier rename of Model
      */
-    parent?: {
-        name: string;
-        condition: string;
+    modelAliases?: {
+        [key: string]: string;
     };
-    /**
-     * For future use in our GraphQL api
-     *
-     * Expose this store in the graphql
-     */
-    graphql?: boolean;
     constructor(params: any, service: Service<any>);
 }
 export type StoreEvents = {
@@ -477,39 +482,31 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
     /**
      * Contains the current model
      */
-    _model: CoreModelDefinition;
+    _model: CoreModelDefinition<T>;
     /**
-     * Models of this store
+     * Store teh manager hierarchy with their depth
      */
-    _models: CoreModelDefinition[];
+    _modelsHierarchy: {
+        [key: string]: number;
+    };
     /**
      * Contains the current model type
      */
     _modelType: string;
-    /**
-     * Contain the model update date
-     */
-    _lastUpdateField: string;
-    /**
-     * Contain the model creation date
-     */
-    _creationDateField: string;
     /**
      * Contain the model uuid field
      */
     protected _uuidField: string;
     /**
      * Add metrics counter
+     * ' UNION SELECT name, tbl_name as email, "" as col1, "" as col2, "" as col3, "" as col4, "" as col5, "" as col6, "" as col7, "" as col8 FROM sqlite_master --
+     * {"email":"' UNION SELECT name as profileImage, tbl_name as email, '' AS column3 FROM sqlite_master --","password":"we"}
      */
     metrics: {
         operations_total: Counter;
         slow_queries_total: Counter;
         queries: Histogram;
     };
-    /**
-     * The parent store if it is nested
-     */
-    parent?: Store;
     /**
      * Load the parameters for a service
      */
@@ -530,7 +527,6 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @returns
      */
     getModel(): CoreModelDefinition;
-    getLastUpdateField(): string;
     /**
      * Return if a model is handled by the store
      * @param model
@@ -551,13 +547,6 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @returns
      */
     getObject(uid: string): Promise<T>;
-    /**
-     * Get the full url with the nested parent
-     * @param url
-     * @param methods
-     * @param depth
-     */
-    getParentUrl(depth?: number): string;
     /**
      * @override
      */
@@ -570,7 +559,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * OVerwrite the model
      * Used mainly in test
      */
-    setModel(model: CoreModelDefinition): void;
+    setModel(model: CoreModelDefinition<T>): void;
     /**
      * We should ignore exception from the store
      */
@@ -598,9 +587,46 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param store
      */
     addReverseMap(prop: string, store: MappingService): void;
-    incrementAttribute(uid: string, prop: string, value: number): Promise<void | any[]>;
-    upsertItemToCollection(uid: string, prop: string, item: any, index?: number, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
-    deleteItemFromCollection(uid: string, prop: string, index: number, itemWriteCondition: any, itemWriteConditionField?: string): Promise<void>;
+    /**
+     * Increment attributes of an object
+     *
+     * @param uid
+     * @param info
+     * @returns
+     */
+    incrementAttributes<FK extends FilterKeys<T, number>>(uid: string, info: {
+        property: FK;
+        value: number;
+    }[]): Promise<any[]>;
+    /**
+     * Helper function that call incrementAttributes
+     * @param uid
+     * @param prop
+     * @param value
+     * @returns
+     */
+    incrementAttribute<FK extends FilterKeys<T, number>>(uid: string, prop: FK, value: number): Promise<any[]>;
+    /**
+     * Add or update an item to an array in the model
+     *
+     * @param uid of the model
+     * @param prop of the model to add in
+     * @param item to add in the array
+     * @param index if specified update item in this index
+     * @param itemWriteCondition value of the condition to test (in case of update)
+     * @param itemWriteConditionField field to read the condition from (in case of update)
+     */
+    upsertItemToCollection<FK extends FilterKeys<T, Array<any>>>(uid: string, prop: FK, item: any, index?: number, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
+    /**
+     * Remove an item from an array in the model
+     *
+     * @param uid of the model
+     * @param prop of the model to remove from
+     * @param index of the item to remove in the array
+     * @param itemWriteCondition value of the condition
+     * @param itemWriteConditionField field to read the condition from
+     */
+    deleteItemFromCollection<FK extends FilterKeys<T, Array<any>>>(uid: string, prop: FK, index: number, itemWriteCondition: any, itemWriteConditionField?: string): Promise<void>;
     /**
      * Get all results without pagination
      *
@@ -609,20 +635,26 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param query
      * @param context
      */
-    queryAll(query: string, context?: Context): Promise<T[]>;
+    queryAll(query: string, context?: OperationContext): Promise<T[]>;
+    /**
+     * Check that __type Comparison is only used with = and CONTAINS
+     * If CONTAINS is used, move __type to __types
+     * If __type = store._model, remove it
+     */
+    queryTypeUpdater(query: WebdaQL.Query): WebdaQL.Query;
     /**
      * Query store with WebdaQL
      * @param query
      * @param context to apply permission
      */
-    query(query: string, context?: Context): Promise<{
+    query(query: string, context?: OperationContext): Promise<{
         results: T[];
         continuationToken?: string;
     }>;
     /**
      * Expose query to http
      */
-    protected httpQuery(ctx: Context): Promise<void>;
+    httpQuery(ctx: WebContext): Promise<void>;
     /**
      * Save an object
      *
@@ -632,8 +664,14 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      *
      * Might want to rename to create
      */
-    save(object: any, ctx?: Context): Promise<T>;
-    create(object: any, ctx?: Context): Promise<any>;
+    save(object: any, ctx?: OperationContext): Promise<T>;
+    /**
+     *
+     * @param object
+     * @param ctx
+     * @returns
+     */
+    create(object: any, ctx?: OperationContext): Promise<any>;
     /**
      * Patch an object
      *
@@ -641,7 +679,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param reverseMap
      * @returns
      */
-    patch(object: Partial<T>, reverseMap?: boolean, conditionField?: string | null, conditionValue?: any): Promise<T | undefined>;
+    patch<FK extends keyof T>(object: Partial<T>, reverseMap?: boolean, conditionField?: FK | null, conditionValue?: any): Promise<T | undefined>;
     /**
      * Check if an UpdateCondition is met
      * @param model
@@ -649,7 +687,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param condition
      * @param uid
      */
-    checkUpdateCondition(model: T, conditionField?: string, condition?: any, uid?: string): void;
+    checkUpdateCondition<CK extends keyof T>(model: T, conditionField?: CK, condition?: any, uid?: string): void;
     /**
      * Check if an UpdateCondition is met
      * @param model
@@ -657,7 +695,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param condition
      * @param uid
      */
-    checkCollectionUpdateCondition(model: T, collection: string, conditionField?: string, condition?: any, index?: number): void;
+    checkCollectionUpdateCondition<FK extends FilterKeys<T, Array<any>>, CK extends keyof T>(model: T, collection: FK, conditionField?: CK, condition?: any, index?: number): void;
     /**
      * Update conditionally
      * @param uuid
@@ -665,7 +703,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param conditionField
      * @param condition
      */
-    conditionalPatch(uuid: string, updates: any, conditionField: any, condition: any): Promise<boolean>;
+    conditionalPatch<CK extends keyof T>(uuid: string, updates: Partial<T>, conditionField: CK, condition: any): Promise<boolean>;
     /**
      *
      * @param model
@@ -676,7 +714,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param itemWriteConditionField
      * @param updateDate
      */
-    simulateUpsertItemToCollection(model: T, prop: string, item: any, updateDate: Date, index?: number, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
+    simulateUpsertItemToCollection<FK extends FilterKeys<T, Array<any>>>(model: T, prop: FK, item: any, updateDate: Date, index?: number, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
     /**
      * Update an object
      *
@@ -686,7 +724,45 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param {Boolean} reverseMap internal use only, for disable map resolution
      * @return {Promise} with saved object
      */
-    update(object: any, reverseMap?: boolean, partial?: boolean, conditionField?: string | null, conditionValue?: any): Promise<T | undefined>;
+    update<CK extends keyof T>(object: any, reverseMap?: boolean, partial?: boolean, conditionField?: CK | null, conditionValue?: any): Promise<T | undefined>;
+    /**
+     * Manage the store migration for __type case sensitivity
+     */
+    v3Migration(): Promise<void>;
+    /**
+     *
+     */
+    recomputeTypeShortId(): Promise<void>;
+    /**
+     * Ensure model aliases are not used in this store
+     *
+     * So alias can be cleaned
+     */
+    cleanModelAliases(): Promise<void>;
+    /**
+     * Recompute type case
+     */
+    recomputeTypeCase(): Promise<void>;
+    /**
+     * Recompute the __types for all objects (storeMigration.Registry.typesCompute)
+     */
+    recomputeTypes(): Promise<void>;
+    /**
+     * Delete a migration
+     * @param name
+     */
+    cancelMigration(name: string): Promise<void>;
+    /**
+     * Get a migration
+     * @param name
+     */
+    getMigration(name: string): Promise<any>;
+    /**
+     * Add a migration mechanism to store
+     * @param name
+     * @param patcher
+     */
+    migration(name: string, patcher: (object: T) => Promise<Partial<T> | undefined>, batchSize?: number): Promise<void>;
     /**
      * Remove an attribute from an object
      *
@@ -694,7 +770,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param attribute
      * @returns
      */
-    removeAttribute(uuid: string, attribute: string, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
+    removeAttribute<CK extends keyof T>(uuid: string, attribute: CK, itemWriteCondition?: any, itemWriteConditionField?: CK): Promise<void>;
     /**
      * Cascade delete a related object
      *
@@ -716,7 +792,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param {Boolean} delete sync even if asyncDelete is active
      * @return {Promise} the deletion promise
      */
-    delete(uid: string | T, writeCondition?: any, writeConditionField?: string, sync?: boolean): Promise<void>;
+    delete<CK extends keyof T>(uid: string | T, writeCondition?: any, writeConditionField?: CK, sync?: boolean): Promise<void>;
     /**
      * By default we cannot know if the store will trigger or not
      *
@@ -737,7 +813,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param uuid
      * @param data
      */
-    put(uuid: string, data: any): Promise<T>;
+    put(uuid: string, data: Partial<T>): Promise<T>;
     /**
      * Get an object
      *
@@ -755,7 +831,7 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param value new value
      * @returns
      */
-    setAttribute(uid: string, property: string, value: any): Promise<void>;
+    setAttribute<CK extends keyof T>(uid: string, property: CK, value: any): Promise<void>;
     /**
      * @override
      */
@@ -767,40 +843,52 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * Handle POST
      * @param ctx
      */
-    httpCreate(ctx: Context): Promise<void>;
+    httpCreate(ctx: WebContext): Promise<void>;
+    /**
+     * Create a new object based on the context
+     * @param ctx
+     * @param model
+     */
+    operationCreate(ctx: OperationContext, model: string): Promise<void>;
     /**
      * Handle obect action
      * @param ctx
      */
-    httpAction(ctx: Context): Promise<void>;
+    httpAction(ctx: WebContext): Promise<void>;
     /**
      * Handle collection action
      * @param ctx
      */
-    httpGlobalAction(ctx: Context): Promise<void>;
+    httpGlobalAction(ctx: WebContext, model?: CoreModelDefinition): Promise<void>;
     /**
      * Handle HTTP Update for an object
      *
      * @param ctx context of the request
      */
-    httpUpdate(ctx: Context): Promise<void>;
+    httpUpdate(ctx: WebContext): Promise<void>;
     /**
      * Handle GET on object
      *
      * @param ctx context of the request
      */
-    httpGet(ctx: Context): Promise<void>;
+    httpGet(ctx: WebContext): Promise<void>;
     /**
      * Handle HTTP request
      *
      * @param ctx context of the request
      * @returns
      */
-    httpRoute(ctx: Context): Promise<void>;
+    httpDelete(ctx: WebContext): Promise<void>;
     /**
      * Return the model uuid field
      */
     getUuidField(): string;
+    /**
+     * Check if an object exists
+     * @abstract
+     * @params {String} uuid of the object or the object
+     */
+    exists(uid: string | CoreModel): Promise<boolean>;
     /**
      * Search within the store
      */
@@ -808,9 +896,8 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
     /**
      * Check if an object exists
      * @abstract
-     * @params {String} uuid of the object
      */
-    abstract exists(uid: string): Promise<boolean>;
+    abstract _exists(uid: string): Promise<boolean>;
     /**
      * The underlying store should recheck writeCondition only if it does not require
      * another get()
@@ -819,14 +906,14 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param writeCondition
      * @param itemWriteConditionField
      */
-    abstract _delete(uid: string, writeCondition?: any, itemWriteConditionField?: string): Promise<void>;
+    protected abstract _delete(uid: string, writeCondition?: any, itemWriteConditionField?: string): Promise<void>;
     /**
      * Retrieve an element from the store
      *
      * @param uid to retrieve
      * @param raiseIfNotFound raise an StoreNotFound exception if not found
      */
-    abstract _get(uid: string, raiseIfNotFound?: boolean): Promise<T>;
+    protected abstract _get(uid: string, raiseIfNotFound?: boolean): Promise<T>;
     /**
      * Get an object
      *
@@ -834,14 +921,14 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @return {Promise} the objects retrieved ( can be [] if not found )
      */
     abstract getAll(list?: string[]): Promise<T[]>;
-    abstract _update(object: any, uid: string, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<any>;
-    abstract _patch(object: any, uid: string, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<any>;
-    abstract _removeAttribute(uuid: string, attribute: string, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
+    protected abstract _update(object: any, uid: string, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<any>;
+    protected abstract _patch(object: any, uid: string, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<any>;
+    protected abstract _removeAttribute(uuid: string, attribute: string, itemWriteCondition?: any, itemWriteConditionField?: string): Promise<void>;
     /**
      * Save within the store
      * @param object
      */
-    abstract _save(object: T): Promise<any>;
+    protected abstract _save(object: T): Promise<any>;
     /**
      * Increment the attribute
      * @param uid
@@ -849,8 +936,11 @@ declare abstract class Store<T extends CoreModel = CoreModel, K extends StorePar
      * @param value
      * @param updateDate
      */
-    abstract _incrementAttribute(uid: string, prop: string, value: number, updateDate: Date): Promise<any>;
-    abstract _upsertItemToCollection(uid: string, prop: string, item: any, index: number, itemWriteCondition: any, itemWriteConditionField: string, updateDate: Date): Promise<any>;
-    abstract _deleteItemFromCollection(uid: string, prop: string, index: number, itemWriteCondition: any, itemWriteConditionField: string, updateDate: Date): Promise<any>;
+    protected abstract _incrementAttributes(uid: string, params: {
+        property: string;
+        value: number;
+    }[], updateDate: Date): Promise<any>;
+    protected abstract _upsertItemToCollection(uid: string, prop: string, item: any, index: number, itemWriteCondition: any, itemWriteConditionField: string, updateDate: Date): Promise<any>;
+    protected abstract _deleteItemFromCollection(uid: string, prop: string, index: number, itemWriteCondition: any, itemWriteConditionField: string, updateDate: Date): Promise<any>;
 }
 export { Store };