@8medusa/utils 2.7.0

package/dist/fulfillment/provider.js

@@ -0,0 +1,412 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractFulfillmentProviderService = void 0;
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the [module's container](https://docs.medusajs.com/learn/fundamentals/modules/container)
+ * using the first parameter, and the module's options using the second parameter.
+ *
+ * :::note
+ *
+ * A module's options are passed when you register it in the Medusa application.
+ *
+ * :::
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts title="src/modules/my-fulfillment/service.ts"
+ * import { AbstractFulfillmentProviderService } from "@8medusa/framework/utils"
+ * import { Logger } from "@8medusa/framework/types"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+ * // other properties...
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor(
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // TODO initialize your client
+ *   }
+ * }
+ *
+ * export default MyFulfillmentProviderService
+ * ```
+ */
+class AbstractFulfillmentProviderService {
+    /**
+     * @ignore
+     */
+    static isFulfillmentService(obj) {
+        return obj?.constructor?._isFulfillmentService;
+    }
+    /**
+     * @ignore
+     */
+    getIdentifier() {
+        return this.constructor.identifier;
+    }
+    /**
+     * This method retrieves a list of fulfillment options that this provider supports. Admin users will then choose from these options when
+     * they're creating a shipping option. The chosen fulfillment option's object is then stored within the created shipping option's `data` property.
+     * The `data` property is useful to store data relevant for the third-party provider to later process the fulfillment.
+     *
+     * This method is useful if your third-party provider allows you to retrieve support options, carriers, or services from an API. You can then
+     * retrieve those and return then in the method, allowing the admin user to choose from the services provided by the third-party provider.
+     *
+     * @returns The list of fulfillment options. Each object in the array should have an `id` property unique to an item, and a `name` property
+     * that's used to display the option in the admin.
+     *
+     * @example
+     * // other imports...
+     * import { FulfillmentOption } from "@8medusa/framework/types"
+     *
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async getFulfillmentOptions(): Promise<FulfillmentOption[]> {
+     *     // assuming you have a client
+     *     const services = await this.client.getServices()
+     *
+     *     return services.map((service) => ({
+     *       id: service.service_id,
+     *       name: service.name,
+     *       service_code: service.code,
+     *       // can add other relevant data for the provider to later process the shipping option.
+     *     }))
+     *   }
+     * }
+     */
+    async getFulfillmentOptions() {
+        throw Error("getFulfillmentOptions must be overridden by the child class");
+    }
+    /**
+     * This method validates the `data` property of a shipping method and returns it. The returned data
+     * is stored in the shipping method's `data` property.
+     *
+     * Your fulfillment provider can use the `data` property to store additional information useful for
+     * handling the fulfillment later. For example, you may store an ID from the third-party fulfillment
+     * system.
+     *
+     * @param optionData - The `data` property of the shipping option.
+     * @param data - The `data` property of the shipping method.
+     * @param context - Context details, such as context of the cart or customer.
+     * @returns the data to store in the `data` property of the shipping method.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async validateFulfillmentData(
+     *     optionData: any,
+     *     data: any,
+     *     context: any
+     *   ): Promise<any> {
+     *     // assuming your client retrieves an ID from the
+     *     // third-party service
+     *     const externalId = await this.client.getId()
+     *
+     *     return {
+     *       ...data,
+     *       externalId
+     *     }
+     *   }
+     * }
+     */
+    async validateFulfillmentData(optionData, data, context) {
+        throw Error("validateFulfillmentData must be overridden by the child class");
+    }
+    /**
+     * This method validates the `data` property of a shipping option when it's created.
+     *
+     * The `data` property can hold useful information that's later added to the `data` attribute
+     * of shipping methods created from this option.
+     *
+     * @param data - The data to validate.
+     * @return Whether the data is valid.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async validateOption(data: any): Promise<boolean> {
+     *     return data.external_id !== undefined
+     *   }
+     * }
+     */
+    async validateOption(data) {
+        throw Error("validateOption must be overridden by the child class");
+    }
+    /**
+     * This method validates whether a shippin option's price can be calculated during checkout. It's executed when the admin user creates a shipping
+     * option of type `calculated`. If this method returns `false`, an error is thrown as the shipping option's price can't be calculated.
+     *
+     * You can perform the checking using the third-party provider if applicable. The `data` parameter will hold the shipping option's `data` property, which
+     * includes the data of a fulfillment option returned by {@link getFulfillmentOptions}.
+     *
+     * @param data - The `data` property of the shipping option.
+     * @returns Whether the price can be calculated for the shipping option.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async canCalculate(data: CreateShippingOptionDTO): Promise<boolean> {
+     *     // assuming you have a client
+     *     return await this.client.hasRates(data.id)
+     *   }
+     * }
+     */
+    async canCalculate(data) {
+        throw Error("canCalculate must be overridden by the child class");
+    }
+    /**
+     * This method calculates the price of a shipping method when it's created or its cart is refreshed.
+     *
+     * In this method, you can send a request to your third-party provider to retrieve the prices. The first
+     * parameters holds the `data` property of the shipping method's shipping option, which has fulfillment
+     * object data returned by {@link getFulfillmentOptions}.
+     *
+     * The second parameter holds the `data` property of the shipping method, which has data returned by {@link validateFulfillmentData}.
+     * It can also hold custom data passed from the frontend during checkout.
+     *
+     * So, using both of these data, assuming you're storing in them data related to the third-party service,
+     * you can retrieve the calculated price of the shipping method.
+     *
+     * @param optionData - The `data` property of a shipping option.
+     * @param data - The shipping method's `data` property with custom data passed from the frontend.
+     * @param context - The context details, such as the cart details.
+     * @returns The calculated price's details.
+     *
+     * @example
+     * import { CalculateShippingOptionPriceDTO } from "@8medusa/framework/types"
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async calculatePrice(
+     *     optionData: CalculateShippingOptionPriceDTO["optionData"],
+     *     data: CalculateShippingOptionPriceDTO["data"],
+     *     context: CalculateShippingOptionPriceDTO["context"]
+     *   ): Promise<CalculatedShippingOptionPrice> {
+     *     // assuming the client can calculate the price using
+     *     // the third-party service
+     *     const price = await this.client.calculate(data)
+     *     return {
+     *       calculated_amount: price,
+     *       // Update this boolean value based on your logic
+     *       is_calculated_price_tax_inclusive: true,
+     *     }
+     *   }
+     * }
+     */
+    async calculatePrice(optionData, data, context) {
+        throw Error("calculatePrice must be overridden by the child class");
+    }
+    /**
+     * This method is used when a fulfillment is created. If the method returns in the object a
+     * `data` property, it's stored in the fulfillment's `data` property.
+     *
+     * The `data` property is useful when handling the fulfillment later,
+     * as you can access information useful for your integration, such as the ID in the
+     * third-party provider.
+     *
+     * You can also use this method to perform an action with the third-party fulfillment service
+     * since a fulfillment is created, such as purchase a label.
+     *
+     * @param data - The `data` property of the shipping method this fulfillment is created for.
+     * @param items - The items in the fulfillment.
+     * @param order - The order this fulfillment is created for.
+     * @param fulfillment - The fulfillment's details.
+     * @returns An object whose `data` property is stored in the fulfillment's `data` property.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async createFulfillment(
+     *     data: any,
+     *     items: any,
+     *     order: any,
+     *     fulfillment: any
+     *   ): Promise<CreateFulfillmentResult> {
+     *     // assuming the client creates a fulfillment
+     *     // in the third-party service
+     *     const externalData = await this.client.create(
+     *       fulfillment,
+     *       items
+     *     )
+     *
+     *     return {
+     *       data: {
+     *         ...(fulfillment.data as object || {}),
+     *         ...externalData
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    async createFulfillment(data, items, order, fulfillment) {
+        throw Error("createFulfillment must be overridden by the child class");
+    }
+    /**
+     * This method is used when a fulfillment is canceled. Use it to perform operations
+     * with the third-party fulfillment service.
+     *
+     * @param data - The fulfillment's `data` property.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async cancelFulfillment(data: Record<string, unknown>): Promise<any> {
+     *     // assuming the client cancels a fulfillment
+     *     // in the third-party service
+     *     const { external_id } = data as {
+     *       external_id: string
+     *     }
+     *     await this.client.cancel(external_id)
+     *   }
+     * }
+     */
+    async cancelFulfillment(data) {
+        throw Error("cancelFulfillment must be overridden by the child class");
+    }
+    /**
+     * This method retrieves the documents of a fulfillment.
+     *
+     * @param data - The `data` property of the fulfillment.
+     * @returns The fulfillment's documents.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async getFulfillmentDocuments(data: any): Promise<never[]> {
+     *     // assuming the client retrieves documents
+     *     // from a third-party service
+     *     return await this.client.documents(data)
+     *   }
+     * }
+     */
+    async getFulfillmentDocuments(data) {
+        return [];
+    }
+    /**
+     * This method is used when a fulfillment is created for a return. If the method returns in the object a
+     * `data` property, it's stored in the fulfillment's `data` property.
+     *
+     * The `data` property is useful when handling the fulfillment later,
+     * as you can access information useful for your integration. For example, you
+     * can store an ID for the fulfillment in the third-party service.
+     *
+     * Use this method to perform actions necessary in the third-party fulfillment service, such as
+     * purchasing a label for the return fulfillment.
+     *
+     * @param fulfillment - The fulfillment's details.
+     * @returns An object containing `data` which is stored in the fulfillment's `data` property and `labels` array which is used to create FulfillmentLabels.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async createReturnFulfillment(fulfillment: Record<string, unknown>): Promise<CreateFulfillmentResult> {
+     *     // assuming the client creates a fulfillment for a return
+     *     // in the third-party service
+     *     const externalData = await this.client.createReturn(
+     *       fulfillment
+     *     )
+     *
+     *     return {
+     *       data: {
+     *         ...(fulfillment.data as object || {}),
+     *         ...externalData
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    async createReturnFulfillment(fulfillment) {
+        throw Error("createReturn must be overridden by the child class");
+    }
+    /**
+     * This method retrieves documents for a return's fulfillment.
+     *
+     * @param data - The `data` property of the fulfillment.
+     * @returns The fulfillment's documents.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async getReturnDocuments(data: any): Promise<never[]> {
+     *     // assuming the client retrieves documents
+     *     // from a third-party service
+     *     return await this.client.documents(data)
+     *   }
+     * }
+     */
+    async getReturnDocuments(data) {
+        return [];
+    }
+    /**
+     * This method retrieves the documents for a shipment.
+     *
+     * @param data - The `data` property of the shipmnet.
+     * @returns The shipment's documents.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async getShipmentDocuments(data: any): Promise<never[]> {
+     *     // assuming the client retrieves documents
+     *     // from a third-party service
+     *     return await this.client.documents(data)
+     *   }
+     * }
+     *
+     */
+    async getShipmentDocuments(data) {
+        return [];
+    }
+    /**
+     * This method retrieves the documents of a fulfillment of a certain type.
+     *
+     * @param fulfillmentData - The `data` property of the fulfillment.
+     * @param documentType - The document's type. For example, `invoice`.
+     * @returns The fulfillment's documents.
+     *
+     * @example
+     * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
+     *   // ...
+     *   async retrieveDocuments(
+     *     fulfillmentData: any,
+     *     documentType: any
+     *   ): Promise<void> {
+     *     // assuming the client retrieves documents
+     *     // from a third-party service
+     *     return await this.client.documents(
+     *       fulfillmentData,
+     *       documentType
+     *     )
+     *   }
+     * }
+     */
+    async retrieveDocuments(fulfillmentData, documentType) {
+        throw Error("retrieveDocuments must be overridden by the child class");
+    }
+}
+exports.AbstractFulfillmentProviderService = AbstractFulfillmentProviderService;
+/**
+ * @ignore
+ */
+AbstractFulfillmentProviderService._isFulfillmentService = true;
+//# sourceMappingURL=provider.js.map

package/dist/fulfillment/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/fulfillment/provider.ts"],"names":[],"mappings":";;;AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAa,kCAAkC;IAsB7C;;OAEG;IACH,MAAM,CAAC,oBAAoB,CAAC,GAAG;QAC7B,OAAO,GAAG,EAAE,WAAW,EAAE,qBAAqB,CAAA;IAChD,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,KAAK,CAAC,6DAA6D,CAAC,CAAA;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,uBAAuB,CAC3B,UAAmC,EACnC,IAA6B,EAC7B,OAAuC;QAEvC,MAAM,KAAK,CAAC,+DAA+D,CAAC,CAAA;IAC9E,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,cAAc,CAAC,IAA6B;QAChD,MAAM,KAAK,CAAC,sDAAsD,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,YAAY,CAAC,IAA6B;QAC9C,MAAM,KAAK,CAAC,oDAAoD,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,cAAc,CAClB,UAAyD,EACzD,IAA6C,EAC7C,OAAmD;QAEnD,MAAM,KAAK,CAAC,sDAAsD,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,iBAAiB,CACrB,IAA6B,EAC7B,KAAyD,EACzD,KAA+C,EAC/C,WAA4E;QAE5E,MAAM,KAAK,CAAC,yDAAyD,CAAC,CAAA;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAA6B;QACnD,MAAM,KAAK,CAAC,yDAAyD,CAAC,CAAA;IACxE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,uBAAuB,CAAC,IAA6B;QACzD,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,uBAAuB,CAC3B,WAAoC;QAEpC,MAAM,KAAK,CAAC,oDAAoD,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,kBAAkB,CAAC,IAA6B;QACpD,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAA6B;QACtD,OAAO,EAAE,CAAA;IACX,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,iBAAiB,CACrB,eAAwC,EACxC,YAAoB;QAEpB,MAAM,KAAK,CAAC,yDAAyD,CAAC,CAAA;IACxE,CAAC;;AAlZH,gFAmZC;AAlYC;;GAEG;AACI,wDAAqB,GAAG,IAAI,CAAA"}

package/dist/fulfillment/shipping-options.d.ts

@@ -0,0 +1,5 @@
+export declare enum ShippingOptionPriceType {
+    CALCULATED = "calculated",
+    FLAT = "flat"
+}
+//# sourceMappingURL=shipping-options.d.ts.map

package/dist/fulfillment/shipping-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-options.d.ts","sourceRoot":"","sources":["../../src/fulfillment/shipping-options.ts"],"names":[],"mappings":"AAAA,oBAAY,uBAAuB;IACjC,UAAU,eAAe;IACzB,IAAI,SAAS;CACd"}

package/dist/fulfillment/shipping-options.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippingOptionPriceType = void 0;
+var ShippingOptionPriceType;
+(function (ShippingOptionPriceType) {
+    ShippingOptionPriceType["CALCULATED"] = "calculated";
+    ShippingOptionPriceType["FLAT"] = "flat";
+})(ShippingOptionPriceType || (exports.ShippingOptionPriceType = ShippingOptionPriceType = {}));
+//# sourceMappingURL=shipping-options.js.map

package/dist/fulfillment/shipping-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-options.js","sourceRoot":"","sources":["../../src/fulfillment/shipping-options.ts"],"names":[],"mappings":";;;AAAA,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,oDAAyB,CAAA;IACzB,wCAAa,CAAA;AACf,CAAC,EAHW,uBAAuB,uCAAvB,uBAAuB,QAGlC"}

package/dist/graphql/clean-graphql.d.ts

@@ -0,0 +1,5 @@
+export declare function cleanGraphQLSchema(schema: string): {
+    schema: string;
+    notFound: Record<string, Record<string, string>>;
+};
+//# sourceMappingURL=clean-graphql.d.ts.map

package/dist/graphql/clean-graphql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-graphql.d.ts","sourceRoot":"","sources":["../../src/graphql/clean-graphql.ts"],"names":[],"mappings":"AAEA,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG;IAClD,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACjD,CAqFA"}

package/dist/graphql/clean-graphql.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanGraphQLSchema = cleanGraphQLSchema;
+const graphql_1 = require("graphql");
+function cleanGraphQLSchema(schema) {
+    const extractTypeNameAndKind = (type) => {
+        if (type.kind === graphql_1.Kind.NAMED_TYPE) {
+            return [type.name.value, type.kind];
+        }
+        if (type.kind === graphql_1.Kind.NON_NULL_TYPE || type.kind === graphql_1.Kind.LIST_TYPE) {
+            return extractTypeNameAndKind(type.type);
+        }
+        return [null, null];
+    };
+    const ast = (0, graphql_1.parse)(schema);
+    const typeNames = new Set(["String", "Int", "Float", "Boolean", "ID"]);
+    const extendedTypes = new Set();
+    const kinds = [
+        graphql_1.Kind.OBJECT_TYPE_DEFINITION,
+        graphql_1.Kind.INTERFACE_TYPE_DEFINITION,
+        graphql_1.Kind.ENUM_TYPE_DEFINITION,
+        graphql_1.Kind.SCALAR_TYPE_DEFINITION,
+        graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION,
+        graphql_1.Kind.UNION_TYPE_DEFINITION,
+    ];
+    ast.definitions.forEach((def) => {
+        if (kinds.includes(def.kind)) {
+            typeNames.add(def.name.value);
+        }
+        else if (def.kind === graphql_1.Kind.OBJECT_TYPE_EXTENSION) {
+            extendedTypes.add(def.name.value);
+        }
+    });
+    const nonExistingMap = {};
+    const parentStack = [];
+    /*
+      Traverse the graph mapping all the entities + fields and removing the ones that don't exist.
+      Extensions are not removed, but marked with a "__extended" key if the main entity doesn't exist. (example: Link modules injecting fields into another module)
+    */
+    const cleanedAst = (0, graphql_1.visit)(ast, {
+        ObjectTypeExtension: {
+            enter(node) {
+                const typeName = node.name.value;
+                parentStack.push(typeName);
+                if (!typeNames.has(typeName)) {
+                    nonExistingMap[typeName] ??= {};
+                    nonExistingMap[typeName]["__extended"] = "";
+                    return null;
+                }
+                return;
+            },
+            leave() {
+                parentStack.pop();
+            },
+        },
+        ObjectTypeDefinition: {
+            enter(node) {
+                parentStack.push(node.name.value);
+            },
+            leave() {
+                parentStack.pop();
+            },
+        },
+        FieldDefinition: {
+            leave(node) {
+                const [typeName, kind] = extractTypeNameAndKind(node.type);
+                if (!typeNames.has(typeName) && kind === graphql_1.Kind.NAMED_TYPE) {
+                    const currentParent = parentStack[parentStack.length - 1];
+                    nonExistingMap[currentParent] ??= {};
+                    nonExistingMap[currentParent][node.name.value] = typeName;
+                    return null;
+                }
+                return;
+            },
+        },
+    });
+    // Return the schema and the map of non existing entities and fields
+    return {
+        schema: (0, graphql_1.print)(cleanedAst),
+        notFound: nonExistingMap,
+    };
+}
+//# sourceMappingURL=clean-graphql.js.map

package/dist/graphql/clean-graphql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-graphql.js","sourceRoot":"","sources":["../../src/graphql/clean-graphql.ts"],"names":[],"mappings":";;AAEA,gDAwFC;AA1FD,qCAAmD;AAEnD,SAAgB,kBAAkB,CAAC,MAAc;IAI/C,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,EAAE;QACtC,IAAI,IAAI,CAAC,IAAI,KAAK,cAAI,CAAC,UAAU,EAAE,CAAC;YAClC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;QACrC,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,cAAI,CAAC,aAAa,IAAI,IAAI,CAAC,IAAI,KAAK,cAAI,CAAC,SAAS,EAAE,CAAC;YACrE,OAAO,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1C,CAAC;QACD,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACrB,CAAC,CAAA;IAED,MAAM,GAAG,GAAG,IAAA,eAAK,EAAC,MAAM,CAAC,CAAA;IAEzB,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAA;IACtE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAE,CAAA;IAE/B,MAAM,KAAK,GAAG;QACZ,cAAI,CAAC,sBAAsB;QAC3B,cAAI,CAAC,yBAAyB;QAC9B,cAAI,CAAC,oBAAoB;QACzB,cAAI,CAAC,sBAAsB;QAC3B,cAAI,CAAC,4BAA4B;QACjC,cAAI,CAAC,qBAAqB;KAC3B,CAAA;IACD,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAQ,EAAE,EAAE;QACnC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;aAAM,IAAI,GAAG,CAAC,IAAI,KAAK,cAAI,CAAC,qBAAqB,EAAE,CAAC;YACnD,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnC,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,cAAc,GAA2C,EAAE,CAAA;IACjE,MAAM,WAAW,GAAa,EAAE,CAAA;IAEhC;;;MAGE;IACF,MAAM,UAAU,GAAG,IAAA,eAAK,EAAC,GAAG,EAAE;QAC5B,mBAAmB,EAAE;YACnB,KAAK,CAAC,IAAI;gBACR,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAA;gBAEhC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;gBAC1B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC7B,cAAc,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAA;oBAC/B,cAAc,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAA;oBAC3C,OAAO,IAAI,CAAA;gBACb,CAAC;gBACD,OAAM;YACR,CAAC;YACD,KAAK;gBACH,WAAW,CAAC,GAAG,EAAE,CAAA;YACnB,CAAC;SACF;QACD,oBAAoB,EAAE;YACpB,KAAK,CAAC,IAAI;gBACR,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACnC,CAAC;YACD,KAAK;gBACH,WAAW,CAAC,GAAG,EAAE,CAAA;YACnB,CAAC;SACF;QACD,eAAe,EAAE;YACf,KAAK,CAAC,IAAI;gBACR,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAE1D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,KAAK,cAAI,CAAC,UAAU,EAAE,CAAC;oBACzD,MAAM,aAAa,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;oBAEzD,cAAc,CAAC,aAAa,CAAC,KAAK,EAAE,CAAA;oBACpC,cAAc,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;oBACzD,OAAO,IAAI,CAAA;gBACb,CAAC;gBACD,OAAM;YACR,CAAC;SACF;KACF,CAAC,CAAA;IAEF,oEAAoE;IACpE,OAAO;QACL,MAAM,EAAE,IAAA,eAAK,EAAC,UAAU,CAAC;QACzB,QAAQ,EAAE,cAAc;KACzB,CAAA;AACH,CAAC"}

package/dist/graphql/extract-relations-from-graphql.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Extracts only the relation fields from the GraphQL type map.
+ * @param {Map<string, any>} typeMap - The GraphQL schema TypeMap.
+ * @returns {Map<string, Map<string, string>>} A map where each key is an entity name, and the values are a map of relation fields and their corresponding entity type.
+ */
+export declare function extractRelationsFromGQL(typeMap: Map<string, any>): Map<string, Map<string, string>>;
+//# sourceMappingURL=extract-relations-from-graphql.d.ts.map

package/dist/graphql/extract-relations-from-graphql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-relations-from-graphql.d.ts","sourceRoot":"","sources":["../../src/graphql/extract-relations-from-graphql.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GACxB,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CA+BlC"}

package/dist/graphql/extract-relations-from-graphql.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractRelationsFromGQL = extractRelationsFromGQL;
+const graphql_1 = require("graphql");
+/**
+ * Extracts only the relation fields from the GraphQL type map.
+ * @param {Map<string, any>} typeMap - The GraphQL schema TypeMap.
+ * @returns {Map<string, Map<string, string>>} A map where each key is an entity name, and the values are a map of relation fields and their corresponding entity type.
+ */
+function extractRelationsFromGQL(typeMap) {
+    const relationMap = new Map();
+    // Extract the actual type
+    const getBaseType = (type) => {
+        if ((0, graphql_1.isNonNullType)(type) || (0, graphql_1.isListType)(type)) {
+            return getBaseType(type.ofType);
+        }
+        return type;
+    };
+    for (const [typeName, graphqlType] of Object.entries(typeMap)) {
+        if (!(0, graphql_1.isObjectType)(graphqlType)) {
+            continue;
+        }
+        const fields = graphqlType.getFields();
+        const entityRelations = new Map();
+        for (const [fieldName, fieldConfig] of Object.entries(fields)) {
+            const fieldType = getBaseType(fieldConfig.type);
+            // only add relation fields
+            if ((0, graphql_1.isObjectType)(fieldType)) {
+                entityRelations.set(fieldName, fieldType.name);
+            }
+        }
+        relationMap.set(typeName, entityRelations);
+    }
+    return relationMap;
+}
+//# sourceMappingURL=extract-relations-from-graphql.js.map

package/dist/graphql/extract-relations-from-graphql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-relations-from-graphql.js","sourceRoot":"","sources":["../../src/graphql/extract-relations-from-graphql.ts"],"names":[],"mappings":";;AAOA,0DAiCC;AAxCD,qCAAiE;AAEjE;;;;GAIG;AACH,SAAgB,uBAAuB,CACrC,OAAyB;IAEzB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAE,CAAA;IAE7B,0BAA0B;IAC1B,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,EAAE;QAC3B,IAAI,IAAA,uBAAa,EAAC,IAAI,CAAC,IAAI,IAAA,oBAAU,EAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACjC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED,KAAK,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9D,IAAI,CAAC,IAAA,sBAAY,EAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,SAAQ;QACV,CAAC;QAED,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,EAAE,CAAA;QACtC,MAAM,eAAe,GAAG,IAAI,GAAG,EAAE,CAAA;QAEjC,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9D,MAAM,SAAS,GAAG,WAAW,CAAE,WAAmB,CAAC,IAAI,CAAC,CAAA;YAExD,2BAA2B;YAC3B,IAAI,IAAA,sBAAY,EAAC,SAAS,CAAC,EAAE,CAAC;gBAC5B,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;YAChD,CAAC;QACH,CAAC;QACD,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;IAC5C,CAAC;IAED,OAAO,WAAW,CAAA;AACpB,CAAC"}

package/dist/graphql/get-fields-and-relations.d.ts

@@ -0,0 +1,11 @@
+import { GraphQLNamedType } from "graphql";
+/**
+ * Generate a list of fields and fields relations for a given type with the requested relations
+ * @param schemaTypeMap
+ * @param typeName
+ * @param relations
+ */
+export declare function gqlGetFieldsAndRelations(schemaTypeMap: {
+    [key: string]: GraphQLNamedType;
+}, typeName: string, relations?: string[]): string[];
+//# sourceMappingURL=get-fields-and-relations.d.ts.map

package/dist/graphql/get-fields-and-relations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-fields-and-relations.d.ts","sourceRoot":"","sources":["../../src/graphql/get-fields-and-relations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAmC,MAAM,SAAS,CAAA;AAE3E;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,aAAa,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAAE,EAClD,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,MAAM,EAAO,YA+BzB"}

package/dist/graphql/get-fields-and-relations.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gqlGetFieldsAndRelations = gqlGetFieldsAndRelations;
+const graphql_1 = require("graphql");
+/**
+ * Generate a list of fields and fields relations for a given type with the requested relations
+ * @param schemaTypeMap
+ * @param typeName
+ * @param relations
+ */
+function gqlGetFieldsAndRelations(schemaTypeMap, typeName, relations = []) {
+    const result = [];
+    function traverseFields(typeName, prefix = "") {
+        const type = schemaTypeMap[typeName];
+        if (!(type instanceof graphql_1.GraphQLObjectType)) {
+            return;
+        }
+        const fields = type.getFields();
+        for (const fieldName in fields) {
+            const field = fields[fieldName];
+            let fieldType = field.type;
+            while (fieldType.ofType) {
+                fieldType = fieldType.ofType;
+            }
+            if (!(0, graphql_1.isObjectType)(fieldType)) {
+                result.push(`${prefix}${fieldName}`);
+            }
+            else if (relations.includes(prefix + fieldName)) {
+                traverseFields(fieldType.name, `${prefix}${fieldName}.`);
+            }
+        }
+    }
+    traverseFields(typeName);
+    return result;
+}
+//# sourceMappingURL=get-fields-and-relations.js.map

package/dist/graphql/get-fields-and-relations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-fields-and-relations.js","sourceRoot":"","sources":["../../src/graphql/get-fields-and-relations.ts"],"names":[],"mappings":";;AAQA,4DAkCC;AA1CD,qCAA2E;AAE3E;;;;;GAKG;AACH,SAAgB,wBAAwB,CACtC,aAAkD,EAClD,QAAgB,EAChB,YAAsB,EAAE;IAExB,MAAM,MAAM,GAAa,EAAE,CAAA;IAE3B,SAAS,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,EAAE;QAC3C,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;QAEpC,IAAI,CAAC,CAAC,IAAI,YAAY,2BAAiB,CAAC,EAAE,CAAC;YACzC,OAAM;QACR,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;QAE/B,KAAK,MAAM,SAAS,IAAI,MAAM,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAA;YAC/B,IAAI,SAAS,GAAG,KAAK,CAAC,IAAW,CAAA;YAEjC,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC;gBACxB,SAAS,GAAG,SAAS,CAAC,MAAM,CAAA;YAC9B,CAAC;YAED,IAAI,CAAC,IAAA,sBAAY,EAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,SAAS,EAAE,CAAC,CAAA;YACtC,CAAC;iBAAM,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;gBAClD,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,CAAC,CAAA;YAC1D,CAAC;QACH,CAAC;IACH,CAAC;IAED,cAAc,CAAC,QAAQ,CAAC,CAAA;IACxB,OAAO,MAAM,CAAA;AACf,CAAC"}