@acmekit/types 2.13.1

package/dist/modules-sdk/index.d.ts

@@ -0,0 +1,244 @@
+import { JoinerRelationship, JoinerServiceConfig } from "../joiner";
+import { AcmeKitContainer } from "../common";
+import { RepositoryService } from "../dal";
+import { Logger } from "../logger";
+import { ModuleProviderExports } from "./module-provider";
+import { RemoteQueryGraph, RemoteQueryInput, RemoteQueryObjectConfig, RemoteQueryObjectFromStringResult } from "./remote-query-object-from-string";
+export { RemoteQueryGraph, RemoteQueryInput, RemoteQueryObjectConfig, RemoteQueryObjectFromStringResult, };
+export type Constructor<T> = new (...args: any[]) => T | (new () => T);
+export * from "../common/acmekit-container";
+export * from "./acmekit-internal-service";
+export * from "./module-provider";
+export * from "./remote-query";
+export * from "./remote-query-entry-points";
+export * from "./to-remote-query";
+export type LogLevel = "query" | "schema" | "error" | "warn" | "info" | "log" | "migration";
+export type LoggerOptions = boolean | "all" | LogLevel[];
+export type CustomModuleDefinition = {
+    key?: string;
+    label?: string;
+    isQueryable?: boolean;
+    dependencies?: string[];
+};
+export type InternalModuleDeclaration = {
+    scope: "internal";
+    dependencies?: string[];
+    definition?: CustomModuleDefinition;
+    resolve?: string | ModuleExports;
+    options?: Record<string, unknown>;
+    /**
+     * If multiple modules are registered with the same key, the alias can be used to differentiate them
+     */
+    alias?: string;
+    /**
+     * If the module is the main module for the key when multiple ones are registered
+     */
+    main?: boolean;
+    worker_mode?: "shared" | "worker" | "server";
+};
+export type ExternalModuleDeclaration = {
+    scope: "external";
+    definition?: CustomModuleDefinition;
+    server?: {
+        type: "http";
+        url: string;
+        keepAlive: boolean;
+    };
+    options?: Record<string, unknown>;
+    /**
+     * If multiple modules are registered with the same key, the alias can be used to differentiate them
+     */
+    alias?: string;
+    /**
+     * If the module is the main module for the key when multiple ones are registered
+     */
+    main?: boolean;
+};
+export type ModuleResolution = {
+    resolutionPath: string | false;
+    definition: ModuleDefinition;
+    options?: Record<string, unknown>;
+    dependencies?: string[];
+    moduleDeclaration?: InternalModuleDeclaration | ExternalModuleDeclaration;
+    moduleExports?: ModuleExports | ModuleProviderExports;
+};
+export type ModuleDefinition = {
+    key: string;
+    defaultPackage: string | false;
+    label: string;
+    resolvePath?: string;
+    isRequired?: boolean;
+    isQueryable?: boolean;
+    dependencies?: string[];
+    /** @internal only used in exceptional cases - relying on the shared contrainer breaks encapsulation */
+    __passSharedContainer?: boolean;
+    defaultModuleDeclaration: InternalModuleDeclaration | ExternalModuleDeclaration;
+};
+export type LinkModuleDefinition = {
+    key: string;
+    label: string;
+    dependencies?: string[];
+    defaultModuleDeclaration: InternalModuleDeclaration;
+};
+type ModuleDeclaration = ExternalModuleDeclaration | InternalModuleDeclaration;
+export type ModuleConfig = ModuleDeclaration & {
+    module: string;
+    path: string;
+    definition: ModuleDefinition;
+};
+export type LoadedModule = unknown & {
+    __joinerConfig: ModuleJoinerConfig;
+    __definition: ModuleDefinition;
+};
+export type LoaderOptions<TOptions = Record<string, unknown>> = {
+    container: AcmeKitContainer;
+    options?: TOptions;
+    logger?: Logger;
+    dataLoaderOnly?: boolean;
+};
+export type ModuleLoaderFunction = (options: LoaderOptions<any>, moduleDeclaration?: InternalModuleDeclaration) => Promise<void>;
+export type ModulesResponse = {
+    module: string;
+    resolution: string | false;
+}[];
+export type LinkModulesExtraFields = Record<string, {
+    type: "date" | "time" | "datetime" | "bigint" | "blob" | "uint8array" | "array" | "enumArray" | "enum" | "json" | "integer" | "smallint" | "tinyint" | "mediumint" | "float" | "double" | "boolean" | "decimal" | "string" | "uuid" | "text";
+    defaultValue?: string;
+    nullable?: boolean;
+    /**
+     * Mikro-orm options for the column
+     */
+    options?: Record<string, unknown>;
+}>;
+/**
+ * A link for two records of linked data models.
+ *
+ * The keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.
+ */
+export type LinkDefinition = {
+    [moduleName: string]: {
+        [fieldName: string]: any;
+    };
+} & {
+    data?: Record<string, unknown>;
+};
+export type ModuleJoinerConfig = Omit<JoinerServiceConfig, "serviceName" | "primaryKeys" | "relationships" | "extends"> & {
+    /**
+     * GraphQL schema for the all module's available entities and fields
+     */
+    schema?: string;
+    idPrefixToEntityName?: Record<string, string>;
+    relationships?: ModuleJoinerRelationship[];
+    extends?: {
+        serviceName: string;
+        entity?: string;
+        fieldAlias?: Record<string, string | {
+            path: string;
+            forwardArgumentsOnPath?: string[];
+            isList?: boolean;
+        }>;
+        relationship: Omit<ModuleJoinerRelationship, "hasMany">;
+    }[];
+    serviceName?: string;
+    primaryKeys?: string[];
+    /**
+     * If the module is a link module
+     */
+    isLink?: boolean;
+    /**
+     * Keys that can be used to link to other modules. e.g { product_id: "Product" } "Product" being the entity it refers to
+     */
+    linkableKeys?: Record<string, string>;
+    /**
+     * If true it expands a RemoteQuery property but doesn't create a pivot table
+     */
+    isReadOnlyLink?: boolean;
+    /**
+     * Fields that will be part of the link record aside from the primary keys that can be updated
+     * If not explicitly defined, this array will be populated by databaseConfig.extraFields
+     */
+    extraDataFields?: string[];
+    databaseConfig?: {
+        /**
+         * Name of the pivot table. If not provided it is auto generated
+         */
+        tableName?: string;
+        /**
+         * Prefix for the id column. If not provided it is "link"
+         */
+        idPrefix?: string;
+        extraFields?: LinkModulesExtraFields;
+    };
+};
+export declare type ModuleJoinerRelationship = JoinerRelationship & {
+    /**
+     * If true, the link joiner will cascade deleting the relationship
+     */
+    deleteCascade?: boolean;
+    /**
+     * The fields to be filterable by the Index module using query.index
+     */
+    filterable?: string[];
+    /**
+     * Allow multiple relationships to exist for this
+     * entity
+     */
+    hasMany?: boolean;
+};
+export type ModuleExports<T = Constructor<any>> = {
+    service: T;
+    loaders?: ModuleLoaderFunction[];
+    runMigrations?(options: LoaderOptions<any>, moduleDeclaration?: InternalModuleDeclaration): Promise<{
+        name: string;
+        path: string;
+    }[]>;
+    revertMigration?(options: LoaderOptions<any>, moduleDeclaration?: InternalModuleDeclaration, migrationNames?: string[]): Promise<void>;
+    generateMigration?(options: LoaderOptions<any>, moduleDeclaration?: InternalModuleDeclaration): Promise<void>;
+    /**
+     * Explicitly set the true location of the module resources.
+     * Can be used to re-export the module from a different location and specify its original location.
+     */
+    discoveryPath?: string;
+};
+export interface ModuleServiceInitializeOptions {
+    database: {
+        /**
+         * Forces to use a shared knex connection
+         */
+        connection?: any;
+        clientUrl?: string;
+        schema?: string;
+        host?: string;
+        port?: number;
+        user?: string;
+        password?: string;
+        database?: string;
+        driverOptions?: Record<string, unknown> & {
+            connection?: Record<string, unknown>;
+        };
+        debug?: boolean;
+        pool?: Record<string, unknown>;
+    };
+}
+export type ModuleServiceInitializeCustomDataLayerOptions = {
+    manager?: any;
+    repositories?: {
+        [key: string]: Constructor<RepositoryService>;
+    };
+};
+export type ModuleBootstrapDeclaration = InternalModuleDeclaration | ExternalModuleDeclaration;
+export interface IModuleService {
+    /**
+     * @ignore
+     */
+    __joinerConfig?(): ModuleJoinerConfig;
+    /**
+     * @ignore
+     */
+    __hooks?: {
+        onApplicationStart?: () => Promise<void>;
+        onApplicationShutdown?: () => Promise<void>;
+        onApplicationPrepareShutdown?: () => Promise<void>;
+    };
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/modules-sdk/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAEnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,GAClC,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAA;AAEtE,cAAc,6BAA6B,CAAA;AAC3C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mBAAmB,CAAA;AAEjC,MAAM,MAAM,QAAQ,GAChB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,WAAW,CAAA;AACf,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,EAAE,CAAA;AAExD,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,WAAW,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACf,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,iBAAiB,CAAC,EAAE,yBAAyB,GAAG,yBAAyB,CAAA;IACzE,aAAa,CAAC,EAAE,aAAa,GAAG,qBAAqB,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,uGAAuG;IACvG,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,wBAAwB,EACpB,yBAAyB,GACzB,yBAAyB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,wBAAwB,EAAE,yBAAyB,CAAA;CACpD,CAAA;AAED,KAAK,iBAAiB,GAAG,yBAAyB,GAAG,yBAAyB,CAAA;AAC9E,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,gBAAgB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG;IACnC,cAAc,EAAE,kBAAkB,CAAA;IAClC,YAAY,EAAE,gBAAgB,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC9D,SAAS,EAAE,gBAAgB,CAAA;IAC3B,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,KAC1C,OAAO,CAAC,IAAI,CAAC,CAAA;AAElB,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,GAAG,KAAK,CAAA;CAC3B,EAAE,CAAA;AAEH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,MAAM,EACN;IACE,IAAI,EACA,MAAM,GACN,MAAM,GACN,UAAU,GACV,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;IACV,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,UAAU,EAAE,MAAM,GAAG;QAEpB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAA;KACzB,CAAA;CACF,GAAG;IACF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,mBAAmB,EACnB,aAAa,GAAG,aAAa,GAAG,eAAe,GAAG,SAAS,CAC5D,GAAG;IACF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7C,aAAa,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAC1C,OAAO,CAAC,EAAE;QACR,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACJ,MAAM,GACN;YACE,IAAI,EAAE,MAAM,CAAA;YACZ,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAA;YACjC,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CACJ,CAAA;QACD,YAAY,EAAE,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAA;KACxD,EAAE,CAAA;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,cAAc,CAAC,EAAE;QACf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,WAAW,CAAC,EAAE,sBAAsB,CAAA;KACrC,CAAA;CACF,CAAA;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAClE;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI;IAChD,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAChC,aAAa,CAAC,CACZ,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC,CAAA;IAC5C,eAAe,CAAC,CACd,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,EAC7C,cAAc,CAAC,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,iBAAiB,CAAC,CAChB,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE;QACR;;WAEG;QACH,UAAU,CAAC,EAAE,GAAG,CAAA;QAChB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;YACxC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SACrC,CAAA;QACD,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAC/B,CAAA;CACF;AAED,MAAM,MAAM,6CAA6C,GAAG;IAC1D,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAA;KAC9C,CAAA;CACF,CAAA;AAED,MAAM,MAAM,0BAA0B,GAClC,yBAAyB,GACzB,yBAAyB,CAAA;AAK7B,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,CAAC,IAAI,kBAAkB,CAAA;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACxC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3C,4BAA4B,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KACnD,CAAA;CACF"}

package/dist/modules-sdk/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../common/acmekit-container"), exports);
+__exportStar(require("./acmekit-internal-service"), exports);
+__exportStar(require("./module-provider"), exports);
+__exportStar(require("./remote-query"), exports);
+__exportStar(require("./remote-query-entry-points"), exports);
+__exportStar(require("./to-remote-query"), exports);
+//# sourceMappingURL=index.js.map

package/dist/modules-sdk/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/modules-sdk/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAsBA,8DAA2C;AAC3C,6DAA0C;AAC1C,oDAAiC;AACjC,iDAA8B;AAC9B,8DAA2C;AAC3C,oDAAiC"}

package/dist/modules-sdk/module-provider.d.ts

@@ -0,0 +1,29 @@
+import { Logger } from "../logger";
+import { Constructor, InternalModuleDeclaration, AcmeKitContainer } from "./index";
+export type ProviderLoaderOptions<TOptions = Record<string, unknown>> = {
+    container: AcmeKitContainer;
+    options?: TOptions;
+    logger?: Logger;
+    moduleOptions: Record<string, unknown>;
+};
+export type ModuleProviderExports<Service = any> = {
+    module?: string;
+    services: Constructor<Service>[];
+    loaders?: ModuleProviderLoaderFunction[];
+    runMigrations?(options: ProviderLoaderOptions<Service>, moduleDeclaration?: any): Promise<void>;
+    revertMigration?(options: ProviderLoaderOptions<Service>, moduleDeclaration?: any): Promise<void>;
+    generateMigration?(options: ProviderLoaderOptions<Service>, moduleDeclaration?: any): Promise<void>;
+    /**
+     * Explicitly set the true location of the module resources.
+     * Can be used to re-export the module from a different location and specify its original location.
+     */
+    discoveryPath?: string;
+};
+export type ModuleProviderLoaderFunction = (options: ProviderLoaderOptions, moduleDeclaration?: InternalModuleDeclaration) => Promise<void>;
+export type ModuleProvider = {
+    resolve: string | ModuleProviderExports<any>;
+    id?: string;
+    options?: Record<string, unknown>;
+    is_default?: boolean;
+};
+//# sourceMappingURL=module-provider.d.ts.map

package/dist/modules-sdk/module-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-provider.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/module-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EACL,WAAW,EACX,yBAAyB,EACzB,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB,MAAM,MAAM,qBAAqB,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IACtE,SAAS,EAAE,gBAAgB,CAAA;IAC3B,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,OAAO,GAAG,GAAG,IAAI;IACjD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAA;IAChC,OAAO,CAAC,EAAE,4BAA4B,EAAE,CAAA;IACxC,aAAa,CAAC,CACZ,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACvC,iBAAiB,CAAC,EAAE,GAAG,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,eAAe,CAAC,CACd,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACvC,iBAAiB,CAAC,EAAE,GAAG,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,iBAAiB,CAAC,CAChB,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,EACvC,iBAAiB,CAAC,EAAE,GAAG,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG,CACzC,OAAO,EAAE,qBAAqB,EAC9B,iBAAiB,CAAC,EAAE,yBAAyB,KAC1C,OAAO,CAAC,IAAI,CAAC,CAAA;AAElB,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAA;IAC5C,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA"}

package/dist/modules-sdk/module-provider.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=module-provider.js.map

package/dist/modules-sdk/module-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-provider.js","sourceRoot":"","sources":["../../src/modules-sdk/module-provider.ts"],"names":[],"mappings":""}

package/dist/modules-sdk/object-to-remote-query-fields.d.ts

@@ -0,0 +1,27 @@
+type Marker = [never, 0, 1, 2, 3, 4];
+type ExcludedProps = "__typename";
+type RawBigNumberPrefix = "raw_";
+type ExpandStarSelector<T extends object, Depth extends number, Exclusion extends string[]> = ObjectToRemoteQueryFields<T & {
+    "*": "*";
+}, Depth, Exclusion>;
+type TypeOnly<T> = Required<Exclude<T, null | undefined>>;
+/**
+ * Output an array of strings representing the path to each leaf node in an object
+ */
+export type ObjectToRemoteQueryFields<MaybeT, Depth extends number = 2, Exclusion extends string[] = [], T = TypeOnly<MaybeT> & {
+    "*": "*";
+}> = Depth extends never ? never : T extends object ? {
+    [K in keyof T]: K extends `${RawBigNumberPrefix}${string}` ? Exclude<K, symbol> : K extends ExcludedProps ? never : K extends Exclusion[number] ? never : TypeOnly<T[K]> extends Array<infer R> ? TypeOnly<R> extends Date ? Exclude<K, symbol> : TypeOnly<R> extends {
+        __typename: any;
+    } ? `${Exclude<K, symbol>}.${ExpandStarSelector<TypeOnly<R>, Marker[Depth], [
+        K & string,
+        ...Exclusion
+    ]>}` : TypeOnly<R> extends object ? Exclude<K, symbol> : never : TypeOnly<T[K]> extends Date ? Exclude<K, symbol> : TypeOnly<T[K]> extends {
+        __typename: any;
+    } ? `${Exclude<K, symbol>}.${ExpandStarSelector<TypeOnly<T[K]>, Marker[Depth], [
+        K & string,
+        ...Exclusion
+    ]>}` : T[K] extends object ? Exclude<K, symbol> : Exclude<K, symbol>;
+}[keyof T] : never;
+export {};
+//# sourceMappingURL=object-to-remote-query-fields.d.ts.map

package/dist/modules-sdk/object-to-remote-query-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-to-remote-query-fields.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/object-to-remote-query-fields.ts"],"names":[],"mappings":"AAAA,KAAK,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;AAEpC,KAAK,aAAa,GAAG,YAAY,CAAA;AACjC,KAAK,kBAAkB,GAAG,MAAM,CAAA;AAEhC,KAAK,kBAAkB,CACrB,CAAC,SAAS,MAAM,EAChB,KAAK,SAAS,MAAM,EACpB,SAAS,SAAS,MAAM,EAAE,IACxB,yBAAyB,CAAC,CAAC,GAAG;IAAE,GAAG,EAAE,GAAG,CAAA;CAAE,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;AAEjE,KAAK,QAAQ,CAAC,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC,CAAC,CAAA;AAEzD;;GAEG;AACH,MAAM,MAAM,yBAAyB,CACnC,MAAM,EACN,KAAK,SAAS,MAAM,GAAG,CAAC,EACxB,SAAS,SAAS,MAAM,EAAE,GAAG,EAAE,EAC/B,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG;IAAE,GAAG,EAAE,GAAG,CAAA;CAAE,IACjC,KAAK,SAAS,KAAK,GACnB,KAAK,GACL,CAAC,SAAS,MAAM,GAChB;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SACjB,GAAG,kBAAkB,GAAG,MAAM,EAAE,GAC5B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAEpB,CAAC,SAAS,aAAa,GACrB,KAAK,GAEP,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,GACzB,KAAK,GACL,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACrC,QAAQ,CAAC,CAAC,CAAC,SAAS,IAAI,GACtB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,QAAQ,CAAC,CAAC,CAAC,SAAS;QAAE,UAAU,EAAE,GAAG,CAAA;KAAE,GACvC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,kBAAkB,CACzC,QAAQ,CAAC,CAAC,CAAC,EACX,MAAM,CAAC,KAAK,CAAC,EACb;QAAC,CAAC,GAAG,MAAM;QAAE,GAAG,SAAS;KAAC,CAC3B,EAAE,GACH,QAAQ,CAAC,CAAC,CAAC,SAAS,MAAM,GAC1B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,KAAK,GACP,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAC3B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,UAAU,EAAE,GAAG,CAAA;KAAE,GAC1C,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,kBAAkB,CACzC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACd,MAAM,CAAC,KAAK,CAAC,EACb;QAAC,CAAC,GAAG,MAAM;QAAE,GAAG,SAAS;KAAC,CAC3B,EAAE,GACH,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACnB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,MAAM,CAAC,CAAC,GACV,KAAK,CAAA"}

package/dist/modules-sdk/object-to-remote-query-fields.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=object-to-remote-query-fields.js.map

package/dist/modules-sdk/object-to-remote-query-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-to-remote-query-fields.js","sourceRoot":"","sources":["../../src/modules-sdk/object-to-remote-query-fields.ts"],"names":[],"mappings":""}

package/dist/modules-sdk/remote-query-entry-points.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Bucket filled with map of entry point -> types that are autogenerated by the CLI
+ */
+export interface RemoteQueryEntryPoints {
+}
+//# sourceMappingURL=remote-query-entry-points.d.ts.map

package/dist/modules-sdk/remote-query-entry-points.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-query-entry-points.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/remote-query-entry-points.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,sBAAsB;CAAG"}

package/dist/modules-sdk/remote-query-entry-points.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remote-query-entry-points.js.map

package/dist/modules-sdk/remote-query-entry-points.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-query-entry-points.js","sourceRoot":"","sources":["../../src/modules-sdk/remote-query-entry-points.ts"],"names":[],"mappings":""}

package/dist/modules-sdk/remote-query-object-from-string.d.ts

@@ -0,0 +1,103 @@
+import { QueryContextType } from "../common";
+import { IndexOrderBy } from "../index-data/query-config/query-input-config-order-by";
+import { ObjectToRemoteQueryFields } from "./object-to-remote-query-fields";
+import { RemoteQueryEntryPoints } from "./remote-query-entry-points";
+import { RemoteQueryFilters } from "./to-remote-query";
+export type RemoteQueryObjectConfig<TEntry extends string> = {
+    entryPoint: TEntry | keyof RemoteQueryEntryPoints;
+    variables?: any;
+    fields: ObjectToRemoteQueryFields<RemoteQueryEntryPoints[TEntry & keyof RemoteQueryEntryPoints]> extends never ? string[] : ObjectToRemoteQueryFields<RemoteQueryEntryPoints[TEntry & keyof RemoteQueryEntryPoints]>[] | string[];
+};
+export type RemoteQueryObjectFromStringResult<TConfig extends RemoteQueryObjectConfig<any>> = {
+    __TConfig: TConfig;
+    __value: object;
+};
+export type RemoteQueryInput<TEntry extends string> = TEntry extends keyof RemoteQueryEntryPoints ? {
+    /**
+     * The name of the entity to retrieve. For example, `product`.
+     */
+    entity: TEntry;
+    /**
+     * The fields and relations to retrieve in the entity.
+     */
+    fields: ObjectToRemoteQueryFields<RemoteQueryEntryPoints[TEntry]> extends never ? string[] : ObjectToRemoteQueryFields<RemoteQueryEntryPoints[TEntry]>[] | string[];
+    /**
+     * Pagination configurations for the returned list of items.
+     */
+    pagination?: {
+        /**
+         * The number of items to skip before retrieving the returned items.
+         */
+        skip?: number;
+        /**
+         * The maximum number of items to return.
+         */
+        take?: number;
+        /**
+         * Sort by field names in ascending or descending order.
+         */
+        order?: IndexOrderBy<TEntry>;
+    };
+    /**
+     * Filters to apply on the retrieved items.
+     */
+    filters?: RemoteQueryFilters<TEntry>;
+    /**
+     * Apply a query context on the retrieved data. For example, to retrieve product prices for a certain context.
+     */
+    context?: QueryContextType;
+    /**
+     * Apply a `withDeleted` flag on the retrieved data to retrieve soft deleted items.
+     */
+    withDeleted?: boolean;
+    /**
+     * Strategy will be send to the entry module called method
+     */
+    strategy?: "joined" | "select-in" | "balanced";
+} : {
+    /**
+     * The name of the entity to retrieve. For example, `product`.
+     */
+    entity: TEntry | keyof RemoteQueryEntryPoints;
+    /**
+     * The fields and relations to retrieve in the entity.
+     */
+    fields: ObjectToRemoteQueryFields<any> extends never ? string[] : ObjectToRemoteQueryFields<any>[] | string[];
+    /**
+     * Pagination configurations for the returned list of items.
+     */
+    pagination?: {
+        /**
+         * The number of items to skip before retrieving the returned items.
+         */
+        skip?: number;
+        /**
+         * The maximum number of items to return.
+         */
+        take?: number;
+        /**
+         * Sort by field names in ascending or descending order.
+         */
+        order?: IndexOrderBy<TEntry>;
+    };
+    /**
+     * Filters to apply on the retrieved items.
+     */
+    filters?: RemoteQueryFilters<TEntry>;
+    /**
+     * Apply a query context on the retrieved data. For example, to retrieve product prices for a certain context.
+     */
+    context?: QueryContextType;
+    /**
+     * Apply a `withDeleted` flag on the retrieved data to retrieve soft deleted items.
+     */
+    withDeleted?: boolean;
+    /**
+     * Strategy will be send to the entry module called method
+     */
+    strategy?: "joined" | "select-in" | "balanced";
+};
+export type RemoteQueryGraph<TEntry extends string> = {
+    __TConfig: RemoteQueryObjectConfig<TEntry>;
+};
+//# sourceMappingURL=remote-query-object-from-string.d.ts.map

package/dist/modules-sdk/remote-query-object-from-string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-query-object-from-string.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/remote-query-object-from-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,wDAAwD,CAAA;AACrF,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAEtD,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,MAAM,IAAI;IAC3D,UAAU,EAAE,MAAM,GAAG,MAAM,sBAAsB,CAAA;IACjD,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,MAAM,EAAE,yBAAyB,CAC/B,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,SAAS,KAAK,GACX,MAAM,EAAE,GAEJ,yBAAyB,CACvB,sBAAsB,CAAC,MAAM,GAAG,MAAM,sBAAsB,CAAC,CAC9D,EAAE,GACH,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,iCAAiC,CAC3C,OAAO,SAAS,uBAAuB,CAAC,GAAG,CAAC,IAC1C;IACF,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAChD,MAAM,SAAS,MAAM,sBAAsB,GACvC;IACE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAC/B,sBAAsB,CAAC,MAAM,CAAC,CAC/B,SAAS,KAAK,GACX,MAAM,EAAE,GAEJ,yBAAyB,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,EAAE,GAC3D,MAAM,EAAE,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,KAAK,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAA;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAA;CAC/C,GACD;IACE;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,sBAAsB,CAAA;IAC7C;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC,GAAG,CAAC,SAAS,KAAK,GAChD,MAAM,EAAE,GACR,yBAAyB,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,EAAE,CAAA;IAC/C;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,KAAK,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAA;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAA;CAC/C,CAAA;AAEP,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IACpD,SAAS,EAAE,uBAAuB,CAAC,MAAM,CAAC,CAAA;CAC3C,CAAA"}

package/dist/modules-sdk/remote-query-object-from-string.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remote-query-object-from-string.js.map

package/dist/modules-sdk/remote-query-object-from-string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-query-object-from-string.js","sourceRoot":"","sources":["../../src/modules-sdk/remote-query-object-from-string.ts"],"names":[],"mappings":""}

package/dist/modules-sdk/remote-query.d.ts

@@ -0,0 +1,104 @@
+import { Prettify } from "../common";
+import { IndexQueryInput, QueryResultSet } from "../index-data/query-config/query-input-config";
+import { RemoteJoinerOptions, RemoteJoinerQuery } from "../joiner";
+import { RemoteQueryEntryPoints } from "./remote-query-entry-points";
+import { RemoteQueryInput, RemoteQueryObjectConfig, RemoteQueryObjectFromStringResult } from "./remote-query-object-from-string";
+export type RemoteQueryFunctionReturnPagination = {
+    skip: number;
+    take: number;
+    count: number;
+};
+/**
+ * The GraphResultSet presents a typed output for the
+ * result returned by the underlying remote query
+ */
+export type GraphResultSet<TEntry extends string> = {
+    data: TEntry extends keyof RemoteQueryEntryPoints ? RemoteQueryEntryPoints[TEntry][] : any[];
+    metadata?: RemoteQueryFunctionReturnPagination;
+};
+/**
+ * QueryGraphFunction is a wrapper on top of remoteQuery
+ * that simplifies the input it accepts and returns
+ * a normalized/consistent output.
+ */
+export type QueryGraphFunction = {
+    <const TEntry extends string>(queryConfig: RemoteQueryInput<TEntry>, options?: RemoteJoinerOptions): Promise<Prettify<GraphResultSet<TEntry>>>;
+};
+/**
+ * QueryIndexFunction is a wrapper on top of indexModule
+ * that simplifies the input it accepts and returns
+ * a normalized/consistent output.
+ */
+export type QueryIndexFunction = {
+    <const TEntry extends string>(queryOptions: IndexQueryInput<TEntry>, options?: RemoteJoinerOptions): Promise<Prettify<QueryResultSet<TEntry>>>;
+};
+export type RemoteQueryFunction = {
+    /**
+     * Query wrapper to provide specific API's and pre processing around remoteQuery.query
+     * @param queryConfig
+     * @param options
+     */
+    <const TEntry extends string>(queryConfig: RemoteQueryObjectConfig<TEntry>, options?: RemoteJoinerOptions): Promise<any>;
+    /**
+     * Query wrapper to provide specific API's and pre processing around remoteQuery.query
+     * @param queryConfig
+     * @param options
+     */
+    <const TConfig extends RemoteQueryObjectFromStringResult<any>>(queryConfig: TConfig, options?: RemoteJoinerOptions): Promise<any>;
+    /**
+     * Query wrapper to provide specific API's and pre processing around remoteQuery.query
+     * @param query
+     * @param options
+     */
+    (query: RemoteJoinerQuery, options?: RemoteJoinerOptions): Promise<any>;
+    /**
+     * Graph function uses the remoteQuery under the hood and
+     * returns a result set
+     */
+    graph: QueryGraphFunction;
+    /**
+     * Index function uses the index module to query and remoteQuery to hydrate the data
+     * returns a result set
+     */
+    index: QueryIndexFunction;
+    /**
+     * Query wrapper to provide specific GraphQL like API around remoteQuery.query
+     * @param query
+     * @param variables
+     * @param options
+     */
+    gql: (query: string, variables?: Record<string, unknown>, options?: RemoteJoinerOptions) => Promise<any>;
+};
+export interface Query {
+    /**
+     * Query wrapper to provide specific API's and pre processing around remoteQuery.query
+     * @param queryConfig
+     * @param options
+     */
+    query<const TEntry extends string>(queryConfig: RemoteQueryObjectConfig<TEntry>, options?: RemoteJoinerOptions): Promise<any>;
+    /**
+     * Query wrapper to provide specific API's and pre processing around remoteQuery.query
+     * @param queryConfig
+     * @param options
+     */
+    query<const TConfig extends RemoteQueryObjectFromStringResult<any>>(queryConfig: TConfig, options?: RemoteJoinerOptions): Promise<any>;
+    /**
+     * Query wrapper to provide specific API's and pre processing around remoteQuery.query
+     * @param query
+     * @param options
+     */
+    query(query: RemoteJoinerQuery, options?: RemoteJoinerOptions): Promise<any>;
+    /**
+     * Graph function uses the remoteQuery under the hood and
+     * returns a result set
+     */
+    graph: QueryGraphFunction;
+    /**
+     * Query wrapper to provide specific GraphQL like API around remoteQuery.query
+     * @param query
+     * @param variables
+     * @param options
+     */
+    gql: (query: string, variables?: Record<string, unknown>, options?: RemoteJoinerOptions) => Promise<any>;
+}
+//# sourceMappingURL=remote-query.d.ts.map

package/dist/modules-sdk/remote-query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-query.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/remote-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACpC,OAAO,EACL,eAAe,EACf,cAAc,EACf,MAAM,+CAA+C,CAAA;AACtD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,mCAAmC,CAAA;AAI1C,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,MAAM,IAAI;IAClD,IAAI,EAAE,MAAM,SAAS,MAAM,sBAAsB,GAC7C,sBAAsB,CAAC,MAAM,CAAC,EAAE,GAChC,GAAG,EAAE,CAAA;IACT,QAAQ,CAAC,EAAE,mCAAmC,CAAA;CAC/C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC1B,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,EACrC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAC7C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC1B,YAAY,EAAE,eAAe,CAAC,MAAM,CAAC,EACrC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAC7C,CAAA;AAiCD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC1B,WAAW,EAAE,uBAAuB,CAAC,MAAM,CAAC,EAC5C,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf;;;;OAIG;IACH,CAAC,KAAK,CAAC,OAAO,SAAS,iCAAiC,CAAC,GAAG,CAAC,EAC3D,WAAW,EAAE,OAAO,EACpB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IACf;;;;OAIG;IACH,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAEvE;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;;;OAKG;IACH,GAAG,EAAE,CACH,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,CAAC,EAAE,mBAAmB,KAC1B,OAAO,CAAC,GAAG,CAAC,CAAA;CAClB,CAAA;AAED,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC/B,WAAW,EAAE,uBAAuB,CAAC,MAAM,CAAC,EAC5C,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,OAAO,SAAS,iCAAiC,CAAC,GAAG,CAAC,EAChE,WAAW,EAAE,OAAO,EACpB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IACf;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE5E;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;;;OAKG;IACH,GAAG,EAAE,CACH,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,CAAC,EAAE,mBAAmB,KAC1B,OAAO,CAAC,GAAG,CAAC,CAAA;CAClB"}

package/dist/modules-sdk/remote-query.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remote-query.js.map

package/dist/modules-sdk/remote-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-query.js","sourceRoot":"","sources":["../../src/modules-sdk/remote-query.ts"],"names":[],"mappings":""}