@deenruv/core 1.0.0

package/dist/config/config.service.js

@@ -0,0 +1,121 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigService = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("typeorm");
+const config_helpers_1 = require("./config-helpers");
+const deenruv_logger_1 = require("./logger/deenruv-logger");
+let ConfigService = class ConfigService {
+    constructor() {
+        this.activeConfig = (0, config_helpers_1.getConfig)();
+        if (this.activeConfig.authOptions.disableAuth) {
+            deenruv_logger_1.Logger.warn("Auth has been disabled. This should never be the case for a production system!");
+        }
+    }
+    get apiOptions() {
+        return this.activeConfig.apiOptions;
+    }
+    get authOptions() {
+        return this.activeConfig.authOptions;
+    }
+    get catalogOptions() {
+        return this.activeConfig.catalogOptions;
+    }
+    get defaultChannelToken() {
+        return this.activeConfig.defaultChannelToken;
+    }
+    get defaultLanguageCode() {
+        return this.activeConfig.defaultLanguageCode;
+    }
+    get entityOptions() {
+        return this.activeConfig.entityOptions;
+    }
+    get entityIdStrategy() {
+        return this.activeConfig.entityIdStrategy;
+    }
+    get assetOptions() {
+        return this.activeConfig.assetOptions;
+    }
+    get dbConnectionOptions() {
+        return this.activeConfig.dbConnectionOptions;
+    }
+    get promotionOptions() {
+        return this.activeConfig.promotionOptions;
+    }
+    get shippingOptions() {
+        return this.activeConfig.shippingOptions;
+    }
+    get orderOptions() {
+        return this.activeConfig.orderOptions;
+    }
+    get paymentOptions() {
+        return this.activeConfig.paymentOptions;
+    }
+    get taxOptions() {
+        return this.activeConfig.taxOptions;
+    }
+    get importExportOptions() {
+        return this.activeConfig.importExportOptions;
+    }
+    get customFields() {
+        if (!this.allCustomFieldsConfig) {
+            this.allCustomFieldsConfig = this.getCustomFieldsForAllEntities();
+        }
+        return this.allCustomFieldsConfig;
+    }
+    get plugins() {
+        return this.activeConfig.plugins;
+    }
+    get logger() {
+        return this.activeConfig.logger;
+    }
+    get jobQueueOptions() {
+        return this.activeConfig.jobQueueOptions;
+    }
+    get systemOptions() {
+        return this.activeConfig.systemOptions;
+    }
+    get dataSourceHooks() {
+        return this.activeConfig.dataSourceHooks || [];
+    }
+    getCustomFieldsForAllEntities() {
+        const definedCustomFields = this.activeConfig.customFields;
+        const metadataArgsStorage = (0, typeorm_1.getMetadataArgsStorage)();
+        // We need to check for any entities which have a "customFields" property but which are not
+        // explicitly defined in the customFields config. This is because the customFields object
+        // only includes the built-in entities. Any custom entities which have a "customFields"
+        // must be dynamically added to the customFields object.
+        if (Array.isArray(this.dbConnectionOptions.entities)) {
+            for (const entity of this.dbConnectionOptions.entities) {
+                if (typeof entity === "function" && !definedCustomFields[entity.name]) {
+                    const hasCustomFields = !!metadataArgsStorage
+                        .filterEmbeddeds(entity)
+                        .find((c) => c.propertyName === "customFields");
+                    const isTranslationEntity = entity.name.endsWith("Translation") &&
+                        metadataArgsStorage
+                            .filterColumns(entity)
+                            .find((c) => c.propertyName === "languageCode");
+                    if (hasCustomFields && !isTranslationEntity) {
+                        definedCustomFields[entity.name] = [];
+                    }
+                }
+            }
+        }
+        return definedCustomFields;
+    }
+};
+exports.ConfigService = ConfigService;
+exports.ConfigService = ConfigService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [])
+], ConfigService);
+//# sourceMappingURL=config.service.js.map

package/dist/config/config.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.service.js","sourceRoot":"","sources":["../../src/config/config.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAiE;AAEjE,qCAAoE;AAEpE,qDAA6C;AAG7C,4DAAgE;AAqBzD,IAAM,aAAa,GAAnB,MAAM,aAAa;IAIxB;QACE,IAAI,CAAC,YAAY,GAAG,IAAA,0BAAS,GAAE,CAAC;QAChC,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;YAC9C,uBAAM,CAAC,IAAI,CACT,gFAAgF,CACjF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;IACtC,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC;IACvC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;IAC1C,CAAC;IAED,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC;IAC/C,CAAC;IAED,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC;IAC/C,CAAC;IAED,IAAI,aAAa;QAEf,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC;IACzC,CAAC;IAED,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC;IAC5C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC;IAC/C,CAAC;IAED,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC;IAC5C,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;IACxC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC,cAA0C,CAAC;IACtE,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;IACtC,CAAC;IAED,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC;IAC/C,CAAC;IAED,IAAI,YAAY;QACd,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,6BAA6B,EAAE,CAAC;QACpE,CAAC;QACD,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;IAClC,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC;IAC3C,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC;IACzC,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC,eAAe,IAAI,EAAE,CAAC;IACjD,CAAC;IAEO,6BAA6B;QACnC,MAAM,mBAAmB,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;QAC3D,MAAM,mBAAmB,GAAG,IAAA,gCAAsB,GAAE,CAAC;QACrD,2FAA2F;QAC3F,yFAAyF;QACzF,uFAAuF;QACvF,wDAAwD;QACxD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,CAAC;gBACvD,IAAI,OAAO,MAAM,KAAK,UAAU,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtE,MAAM,eAAe,GAAG,CAAC,CAAC,mBAAmB;yBAC1C,eAAe,CAAC,MAAM,CAAC;yBACvB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,cAAc,CAAC,CAAC;oBAClD,MAAM,mBAAmB,GACvB,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;wBACnC,mBAAmB;6BAChB,aAAa,CAAC,MAAM,CAAC;6BACrB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,cAAc,CAAC,CAAC;oBACpD,IAAI,eAAe,IAAI,CAAC,mBAAmB,EAAE,CAAC;wBAC5C,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;oBACxC,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,mBAAmB,CAAC;IAC7B,CAAC;CACF,CAAA;AA/HY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;;GACA,aAAa,CA+HzB"}

package/dist/config/custom-field/custom-field-types.d.ts

@@ -0,0 +1,128 @@
+import { BooleanCustomFieldConfig as GraphQLBooleanCustomFieldConfig, CustomField, DateTimeCustomFieldConfig as GraphQLDateTimeCustomFieldConfig, FloatCustomFieldConfig as GraphQLFloatCustomFieldConfig, IntCustomFieldConfig as GraphQLIntCustomFieldConfig, LocaleStringCustomFieldConfig as GraphQLLocaleStringCustomFieldConfig, LocaleTextCustomFieldConfig as GraphQLLocaleTextCustomFieldConfig, LocalizedString, Permission, RelationCustomFieldConfig as GraphQLRelationCustomFieldConfig, StringCustomFieldConfig as GraphQLStringCustomFieldConfig, TextCustomFieldConfig as GraphQLTextCustomFieldConfig } from "@deenruv/common/lib/generated-types";
+import { CustomFieldsObject, CustomFieldType, DefaultFormComponentId, Type, UiComponentConfig } from "@deenruv/common/lib/shared-types";
+import { RequestContext } from "../../api/common/request-context";
+import { Injector } from "../../common/injector";
+import { DeenruvEntity } from "../../entity/base/base.entity";
+export type DefaultValueType<T extends CustomFieldType> = T extends 'string' | 'localeString' | 'text' | 'localeText' ? string : T extends 'int' | 'float' ? number : T extends 'boolean' ? boolean : T extends 'datetime' ? Date : T extends 'relation' ? any : never;
+export type BaseTypedCustomFieldConfig<T extends CustomFieldType, C extends CustomField> = Omit<C, "__typename" | "list" | "requiresPermission"> & {
+    type: T;
+    /**
+     * @description
+     * Whether the custom field is available via the Shop API.
+     * @default true
+     */
+    public?: boolean;
+    nullable?: boolean;
+    unique?: boolean;
+    /**
+     * @description
+     * The permission(s) required to read or write to this field.
+     * If the user has at least one of these permissions, they will be
+     * able to access the field.
+     *
+     * @since 2.2.0
+     */
+    requiresPermission?: Array<Permission | string> | Permission | string;
+    ui?: UiComponentConfig<DefaultFormComponentId | string>;
+};
+/**
+ * @description
+ * Configures a custom field on an entity in the {@link CustomFields} config object.
+ *
+ * @docsCategory custom-fields
+ */
+export type TypedCustomSingleFieldConfig<T extends CustomFieldType, C extends CustomField> = BaseTypedCustomFieldConfig<T, C> & {
+    list?: false;
+    defaultValue?: DefaultValueType<T>;
+    validate?: (value: DefaultValueType<T>, injector: Injector, ctx: RequestContext) => string | LocalizedString[] | void | Promise<string | LocalizedString[] | void>;
+};
+export type TypedCustomListFieldConfig<T extends CustomFieldType, C extends CustomField> = BaseTypedCustomFieldConfig<T, C> & {
+    list?: true;
+    defaultValue?: Array<DefaultValueType<T>>;
+    validate?: (value: Array<DefaultValueType<T>>) => string | LocalizedString[] | void;
+};
+export type TypedCustomFieldConfig<T extends CustomFieldType, C extends CustomField> = BaseTypedCustomFieldConfig<T, C> & (TypedCustomSingleFieldConfig<T, C> | TypedCustomListFieldConfig<T, C>);
+export type StringCustomFieldConfig = TypedCustomFieldConfig<"string", GraphQLStringCustomFieldConfig>;
+export type LocaleStringCustomFieldConfig = TypedCustomFieldConfig<"localeString", GraphQLLocaleStringCustomFieldConfig>;
+export type TextCustomFieldConfig = TypedCustomFieldConfig<"text", GraphQLTextCustomFieldConfig>;
+export type LocaleTextCustomFieldConfig = TypedCustomFieldConfig<"localeText", GraphQLLocaleTextCustomFieldConfig>;
+export type IntCustomFieldConfig = TypedCustomFieldConfig<"int", GraphQLIntCustomFieldConfig>;
+export type FloatCustomFieldConfig = TypedCustomFieldConfig<"float", GraphQLFloatCustomFieldConfig>;
+export type BooleanCustomFieldConfig = TypedCustomFieldConfig<"boolean", GraphQLBooleanCustomFieldConfig>;
+export type DateTimeCustomFieldConfig = TypedCustomFieldConfig<"datetime", GraphQLDateTimeCustomFieldConfig>;
+export type RelationCustomFieldConfig = TypedCustomFieldConfig<"relation", Omit<GraphQLRelationCustomFieldConfig, "entity" | "scalarFields">> & {
+    entity: Type<DeenruvEntity>;
+    graphQLType?: string;
+    eager?: boolean;
+    inverseSide?: string | ((object: any) => any);
+};
+/**
+ * @description
+ * An object used to configure a custom field.
+ *
+ * @docsCategory custom-fields
+ */
+export type CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFieldConfig | TextCustomFieldConfig | LocaleTextCustomFieldConfig | IntCustomFieldConfig | FloatCustomFieldConfig | BooleanCustomFieldConfig | DateTimeCustomFieldConfig | RelationCustomFieldConfig;
+/**
+ * @description
+ * Most entities can have additional fields added to them by defining an array of {@link CustomFieldConfig}
+ * objects on against the corresponding key.
+ *
+ * @example
+ * ```ts
+ * bootstrap({
+ *     // ...
+ *     customFields: {
+ *         Product: [
+ *             { name: 'infoUrl', type: 'string' },
+ *             { name: 'downloadable', type: 'boolean', defaultValue: false },
+ *             { name: 'shortName', type: 'localeString' },
+ *         ],
+ *         User: [
+ *             { name: 'socialLoginToken', type: 'string', public: false },
+ *         ],
+ *     },
+ * })
+ * ```
+ *
+ * @docsCategory custom-fields
+ */
+export type CustomFields = {
+    Address?: CustomFieldConfig[];
+    Administrator?: CustomFieldConfig[];
+    Asset?: CustomFieldConfig[];
+    Channel?: CustomFieldConfig[];
+    Collection?: CustomFieldConfig[];
+    Customer?: CustomFieldConfig[];
+    CustomerGroup?: CustomFieldConfig[];
+    Facet?: CustomFieldConfig[];
+    FacetValue?: CustomFieldConfig[];
+    Fulfillment?: CustomFieldConfig[];
+    GlobalSettings?: CustomFieldConfig[];
+    Order?: CustomFieldConfig[];
+    OrderLine?: CustomFieldConfig[];
+    PaymentMethod?: CustomFieldConfig[];
+    Product?: CustomFieldConfig[];
+    ProductOption?: CustomFieldConfig[];
+    ProductOptionGroup?: CustomFieldConfig[];
+    ProductVariant?: CustomFieldConfig[];
+    ProductVariantPrice?: CustomFieldConfig[];
+    Promotion?: CustomFieldConfig[];
+    Region?: CustomFieldConfig[];
+    Seller?: CustomFieldConfig[];
+    ShippingMethod?: CustomFieldConfig[];
+    StockLocation?: CustomFieldConfig[];
+    TaxCategory?: CustomFieldConfig[];
+    TaxRate?: CustomFieldConfig[];
+    User?: CustomFieldConfig[];
+    Zone?: CustomFieldConfig[];
+} & {
+    [entity: string]: CustomFieldConfig[];
+};
+/**
+ * This interface should be implemented by any entity which can be extended
+ * with custom fields.
+ */
+export interface HasCustomFields {
+    customFields: CustomFieldsObject;
+}

package/dist/config/custom-field/custom-field-types.js

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

package/dist/config/custom-field/custom-field-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-types.js","sourceRoot":"","sources":["../../../src/config/custom-field/custom-field-types.ts"],"names":[],"mappings":""}