@webda/azure 0.0.0-stage → 4.0.0-beta.14

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

@@ -0,0 +1,253 @@
+import { Container, CosmosClient, PatchOperation, SqlQuerySpec } from "@azure/cosmos";
+import { MemoryRepository, ModelClass, Repository, SecretString, Store, StoreParameters } from "@webda/core";
+import * as QL from "@webda/ql";
+import { AzureServiceParameters } from "./azure-parameters.js";
+import { AzureContributor, AzureDeployerInfo, AzureResourceContribution } from "./contributors.js";
+/** Cosmos DB NoSQL settings. All models in the store share a typed container. */
+export declare class CosmosStoreParameters extends StoreParameters implements AzureServiceParameters {
+    /**
+     * Endpoint
+     */
+    endpoint: string;
+    /**
+     * Key
+     */
+    key?: string | SecretString;
+    /**
+     * Database
+     */
+    database: string;
+    /**
+     * Container
+     */
+    container: string;
+    /**
+     * Partition key
+     */
+    partitionKey: string;
+    /**
+     * Create if not exists
+     */
+    createIfNotExists: boolean;
+    /**
+     * Throughput
+     */
+    throughput?: number;
+    /**
+     * Tenant ID
+     */
+    tenantId?: string;
+    /**
+     * Client ID
+     */
+    clientId?: string;
+    /**
+     * Client secret
+     */
+    clientSecret?: string | SecretString;
+    /**
+     * Subscription ID
+     */
+    subscriptionId?: string;
+    /**
+     * Perform load.
+     * @override
+     */
+    load(params?: any): this;
+}
+/**
+ * Translate the supported WebdaQL filter subset with bound values and quoted field identifiers.
+ * @param query - WebdaQL query or parsed filter
+ * @returns SQL text and bound parameters
+ */
+export declare function cosmosQuery(query: QL.Query): SqlQuerySpec;
+/**
+ * Cosmos document type definition
+ */
+type CosmosDocument = Record<string, any> & {
+    id: string;
+    value: Record<string, any>;
+    _etag?: string;
+};
+/** Typed Cosmos repository. A serializer envelope preserves dates, behaviors and concrete model types. */
+export declare class CosmosRepository<T extends ModelClass> extends MemoryRepository<T> {
+    protected container: () => Container;
+    protected partitionKey: string;
+    /**
+     * Initialize the Azure integration.
+     * @param model - Model class or model identifier
+     * @param pks - Primary key field names
+     * @param container - Lazy Cosmos container accessor
+     * @param partitionKey - Cosmos partition key path
+     * @param separator - Composite primary key separator
+     */
+    constructor(model: T, pks: string[], container: () => Container, partitionKey?: string, separator?: string);
+    /**
+     * Encode the model primary key as a Cosmos item identifier.
+     * @param primaryKey - Model primary key
+     * @returns The key result
+     */
+    protected key(primaryKey: any): string;
+    /**
+     * Resolve the partition value from the primary key.
+     * @param primaryKey - Model primary key
+     * @returns The partition result
+     */
+    protected partition(primaryKey: any): string | number | boolean;
+    /**
+     * Address a Cosmos document by its item and partition keys.
+     * @param primaryKey - Model primary key
+     * @returns The item result
+     */
+    protected item(primaryKey: any): import("@azure/cosmos").Item;
+    /**
+     * Serialize a model into a typed Cosmos document.
+     * @param item - Collection item or model instance
+     * @returns The document result
+     */
+    protected document(item: InstanceType<T>): CosmosDocument;
+    /**
+     * Restore a typed model from a Cosmos document.
+     * @param document - Stored Cosmos document
+     * @returns The from document result
+     */
+    protected fromDocument(document: CosmosDocument): InstanceType<T>;
+    /**
+     * Map Cosmos storage errors to Webda errors.
+     * @param primaryKey - Model primary key
+     * @param error - Azure SDK error
+     */
+    protected translateError(primaryKey: any, error: unknown): never;
+    /**
+     * Read a Cosmos document or raise the store not-found error.
+     * @param primaryKey - Model primary key
+     * @returns The read result
+     */
+    protected read(primaryKey: any): Promise<CosmosDocument>;
+    /**
+     * Perform get.
+     * @override
+     */
+    get(primaryKey: any): Promise<any>;
+    /**
+     * Perform exists.
+     * @override
+     */
+    exists(primaryKey: any): Promise<boolean>;
+    /**
+     * Perform create.
+     * @override
+     */
+    create(data: any, save?: boolean): Promise<InstanceType<T>>;
+    /**
+     * Validate a write condition against the current document.
+     * @param primaryKey - Model primary key
+     * @param document - Stored Cosmos document
+     * @param field - Conditional write field
+     * @param expected - Expected field value
+     */
+    protected checkWriteCondition(primaryKey: any, document: CosmosDocument, field?: string | null, expected?: any): void;
+    /**
+     * Use the shared model mutation helpers, then submit the complete change atomically under the read ETag.
+     * @param primaryKey - Model primary key
+     * @param change - Model mutation applied through shared repository helpers
+     * @param conditionField - Conditional write field
+     * @param condition - Expected write condition
+     * @param native - Native atomic Cosmos patch operations
+     */
+    protected mutate(primaryKey: any, change: (repository: MemoryRepository<T>) => Promise<unknown>, conditionField?: string | null, condition?: any, native?: PatchOperation[]): Promise<void>;
+    /**
+     * Perform update.
+     * @override
+     */
+    update(data: any, conditionField?: any, condition?: any): Promise<void>;
+    /**
+     * Perform patch.
+     * @override
+     */
+    patch(primaryKey: any, data: any, field?: any, expected?: any): Promise<void>;
+    /**
+     * Perform delete.
+     * @override
+     */
+    delete(primaryKey: any, field?: any, expected?: any): Promise<void>;
+    /**
+     * Perform remove attribute.
+     * @override
+     */
+    removeAttribute(primaryKey: any, attribute: any, field?: any, expected?: any): Promise<void>;
+    /**
+     * Perform increment attributes.
+     * @override
+     */
+    incrementAttributes(primaryKey: any, info: any, field?: any, expected?: any): Promise<Record<string, number>>;
+    /**
+     * Perform upsert item to collection.
+     * @override
+     */
+    upsertItemToCollection(primaryKey: any, collection: any, item: any, index?: number, field?: any, expected?: any): Promise<void>;
+    /**
+     * Perform delete item from collection.
+     * @override
+     */
+    deleteItemFromCollection(primaryKey: any, collection: any, index: number, field?: any, expected?: any): Promise<void>;
+    /**
+     * Perform query.
+     * @override
+     */
+    query(query: string | any, params?: QL.QueryParameters): Promise<{
+        results: InstanceType<T>[];
+        continuationToken?: string;
+    }>;
+    /**
+     * Perform iterate.
+     * @override
+     */
+    iterate(query: string, params?: QL.QueryParameters): AsyncGenerator<InstanceType<T>>;
+    /**
+     * Perform delete many.
+     * @override
+     */
+    deleteMany(): Promise<number>;
+    /**
+     * Perform update many.
+     * @override
+     */
+    updateMany(): Promise<number>;
+}
+/** Cosmos DB NoSQL store using optimistic ETags and atomic document patches.
+ * @WebdaModda
+ */
+export declare class CosmosStore extends Store<CosmosStoreParameters> implements AzureContributor {
+    /**
+     * Parameters
+     */
+    static Parameters: typeof CosmosStoreParameters;
+    /**
+     * Client
+     */
+    protected client: CosmosClient;
+    /**
+     * Perform init.
+     * @override
+     */
+    init(): Promise<this>;
+    /**
+     * Perform get repository.
+     * @override
+     */
+    getRepository<T extends ModelClass>(model: T): Repository<T>;
+    /**
+     * Perform stop.
+     * @override
+     */
+    stop(): Promise<void>;
+    /**
+     * Describe the Azure resources and identity permissions required by this service.
+     * @param deployer - Deployment scope and identity helpers
+     * @returns The azure resources result
+     */
+    getAzureResources(deployer: AzureDeployerInfo): AzureResourceContribution;
+}
+export {};
+//# sourceMappingURL=cosmos.service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cosmos.service.d.ts","sources":["../../src/services/cosmos.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACtF,OAAO,EAGL,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,YAAY,EACZ,KAAK,EAEL,eAAe,EAIhB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,sBAAsB,EAA2C,MAAM,uBAAuB,CAAC;AACxG,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAGnG,iFAAiF;AACjF,qBAAa,qBAAsB,SAAQ,eAAgB,YAAW,sBAAsB;IAC1F;;OAEG;IACH,QAAQ,EAAG,MAAM,CAAC;IAClB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAG,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAG,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,SAAS;IACrB;;OAEG;IACH,iBAAiB,UAAS;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAG3B;CACF;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,YAAY,CA+CzD;AAED;;GAEG;AACH,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvG,0GAA0G;AAC1G,qBAAa,gBAAgB,CAAC,CAAC,SAAS,UAAU,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IAY3E,SAAS,CAAC,SAAS,EAAE,MAAM,SAAS;IACpC,SAAS,CAAC,YAAY;IAZxB;;;;;;;OAOG;IACH,YACE,KAAK,EAAE,CAAC,EACR,GAAG,EAAE,MAAM,EAAE,EACH,SAAS,EAAE,MAAM,SAAS,EAC1B,YAAY,SAAQ,EAC9B,SAAS,CAAC,EAAE,MAAM,EAWnB;IAED;;;;OAIG;IACH,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,GAAG,MAAM,CAErC;IACD;;;;OAIG;IACH,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAM9D;IACD;;;;OAIG;IACH,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,gCAE7B;IACD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,cAAc,CAMxD;IACD;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,cAAc,GAAG,YAAY,CAAC,CAAC,CAAC,CAYhE;IACD;;;;OAIG;IACH,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,CAM/D;IACD;;;;OAIG;IACH,UAAgB,IAAI,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC,CAQ7D;IAED;;;OAGG;IACG,GAAG,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAEvC;IACD;;;OAGG;IACG,MAAM,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAQ9C;IACD;;;OAGG;IACG,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,UAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAU7D;IAED;;;;;;OAMG;IACH,SAAS,CAAC,mBAAmB,CAC3B,UAAU,EAAE,GAAG,EACf,QAAQ,EAAE,cAAc,EACxB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,QAAQ,CAAC,EAAE,GAAG,GACb,IAAI,CAYN;IAED;;;;;;;OAOG;IACH,UAAgB,MAAM,CACpB,UAAU,EAAE,GAAG,EACf,MAAM,EAAE,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,EAC7D,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,EAC9B,SAAS,CAAC,EAAE,GAAG,EACf,MAAM,CAAC,EAAE,cAAc,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC,CAqCf;IAED;;;OAGG;IACG,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAa5E;IACD;;;OAGG;IACG,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAMlF;IACD;;;OAGG;IACG,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAQxE;IACD;;;OAGG;IACG,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjG;IACD;;;OAGG;IACG,mBAAmB,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAgClH;IACD;;;OAGG;IACG,sBAAsB,CAC1B,UAAU,EAAE,GAAG,EACf,UAAU,EAAE,GAAG,EACf,IAAI,EAAE,GAAG,EACT,KAAK,CAAC,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,GAAG,EACX,QAAQ,CAAC,EAAE,GAAG,GACb,OAAO,CAAC,IAAI,CAAC,CAIf;IACD;;;OAGG;IACG,wBAAwB,CAC5B,UAAU,EAAE,GAAG,EACf,UAAU,EAAE,GAAG,EACf,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,GAAG,EACX,QAAQ,CAAC,EAAE,GAAG,GACb,OAAO,CAAC,IAAI,CAAC,CAIf;IAED;;;OAGG;IACG,KAAK,CACT,KAAK,EAAE,MAAM,GAAG,GAAG,EACnB,MAAM,CAAC,EAAE,EAAE,CAAC,eAAe,GAC1B,OAAO,CAAC;QAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAiBrE;IACD;;;OAGG;IACI,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,eAAe,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAO1F;IACD;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAElC;IACD;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAElC;CACF;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK,CAAC,qBAAqB,CAAE,YAAW,gBAAgB;IACvF;;OAEG;IACH,MAAM,CAAC,UAAU,+BAAyB;IAC1C;;OAEG;IACH,SAAS,CAAC,MAAM,EAAG,YAAY,CAAC;IAEhC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAiB1B;IAED;;;OAGG;IAEH,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAe3D;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAG1B;IAED;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,yBAAyB,CAoCxE;CACF"}