@infrab4a/connect 0.17.0-beta.8 → 0.17.1-beta.1

package/README.md

@@ -1,24 +1,24 @@
-# B4aFirebase
-
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.1.6.
-
-## Code scaffolding
-
-Run `ng generate component component-name --project b4a-firebase` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project b4a-firebase`.
-> Note: Don't forget to add `--project b4a-firebase` or else it will be added to the default project in your `angular.json` file. 
-
-## Build
-
-Run `ng build b4a-firebase` to build the project. The build artifacts will be stored in the `dist/` directory.
-
-## Publishing
-
-After building your library with `ng build b4a-firebase`, go to the dist folder `cd dist/b4a-firebase` and run `npm publish`.
-
-## Running unit tests
-
-Run `ng test b4a-firebase` to execute the unit tests via [Karma](https://karma-runner.github.io).
-
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+# B4aFirebase
+
+This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.1.6.
+
+## Code scaffolding
+
+Run `ng generate component component-name --project b4a-firebase` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project b4a-firebase`.
+> Note: Don't forget to add `--project b4a-firebase` or else it will be added to the default project in your `angular.json` file. 
+
+## Build
+
+Run `ng build b4a-firebase` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+## Publishing
+
+After building your library with `ng build b4a-firebase`, go to the dist folder `cd dist/b4a-firebase` and run `npm publish`.
+
+## Running unit tests
+
+Run `ng test b4a-firebase` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Further help
+
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).

package/index.ts

@@ -0,0 +1 @@
+export * from './src'

package/karma.conf.js

@@ -0,0 +1,32 @@
+// Karma configuration file, see link for more information
+// https://karma-runner.github.io/1.0/config/configuration-file.html
+
+module.exports = function (config) {
+  config.set({
+    basePath: '',
+    frameworks: ['jasmine', '@angular-devkit/build-angular'],
+    plugins: [
+      require('karma-jasmine'),
+      require('karma-chrome-launcher'),
+      require('karma-jasmine-html-reporter'),
+      require('karma-coverage-istanbul-reporter'),
+      require('@angular-devkit/build-angular/plugins/karma'),
+    ],
+    client: {
+      clearContext: false, // leave Jasmine Spec Runner output visible in browser
+    },
+    coverageIstanbulReporter: {
+      dir: require('path').join(__dirname, '../../coverage/connect'),
+      reports: ['html', 'lcovonly', 'text-summary'],
+      fixWebpackSourcePaths: true,
+    },
+    reporters: ['progress', 'kjhtml'],
+    port: 9876,
+    colors: true,
+    logLevel: config.LOG_INFO,
+    autoWatch: true,
+    browsers: ['Chrome'],
+    singleRun: false,
+    restartOnFileChange: true,
+  })
+}

package/ng-package.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../dist/connect",
+  "lib": {
+    "entryFile": "src/index.ts",
+    "umdModuleIds": {
+      "axios": "axios",
+      "class-transformer": "class-transformer",
+      "date-fns": "date-fns",
+      "firebase": "firebase",
+      "lodash": "lodash",
+      "tsMd5": "ts-md5"
+    }
+  },
+  "allowedNonPeerDependencies": [
+    "axios",
+    "class-transformer",
+    "date-fns",
+    "firebase",
+    "lodash",
+    "reflect-metadata",
+    "ts-md5"
+  ]
+}

package/package.json

@@ -1,28 +1,20 @@
-{
-  "name": "@infrab4a/connect",
-  "version": "0.17.0-beta.8",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/B4AGroup/b4a-firebase-libs"
-  },
-  "dependencies": {
-    "axios": "^0.27.2",
-    "class-transformer": "^0.4.0",
-    "date-fns": "^2.28.0",
-    "firebase": "7.24.0",
-    "lodash": "^4.17.21",
-    "reflect-metadata": "^0.1.13",
-    "ts-md5": "^1.2.9",
-    "tslib": "^2.2.0"
-  },
-  "main": "bundles/infrab4a-connect.umd.js",
-  "module": "fesm2015/infrab4a-connect.js",
-  "es2015": "fesm2015/infrab4a-connect.js",
-  "esm2015": "esm2015/infrab4a-connect.js",
-  "fesm2015": "fesm2015/infrab4a-connect.js",
-  "typings": "infrab4a-connect.d.ts",
-  "sideEffects": false
-}
+{
+  "name": "@infrab4a/connect",
+  "version": "0.17.1-beta.1",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/B4AGroup/b4a-firebase-libs"
+  },
+  "dependencies": {
+    "axios": "^0.27.2",
+    "class-transformer": "^0.4.0",
+    "date-fns": "^2.28.0",
+    "firebase": "7.24.0",
+    "lodash": "^4.17.21",
+    "reflect-metadata": "^0.1.13",
+    "ts-md5": "^1.2.9"
+  }
+}

package/src/domain/catalog/index.ts

@@ -0,0 +1,2 @@
+export * from './models'
+export * from './repositories'

package/src/domain/catalog/models/category.ts

@@ -0,0 +1,27 @@
+import { BaseModel, IdentifierFields, NonFunctionPropertyNames } from '../../general/model'
+import { Shops } from './enums'
+
+import { CategoryCondition, CategoryFilter } from './types'
+
+export class Category extends BaseModel<Category> implements IdentifierFields<Category> {
+  id: string
+  brandCategory: boolean
+  brandLogo?: string
+  name: string
+  slug: string
+  image?: string
+  brandCategoryBanner?: string
+  brandCategoryBannerMobile?: string
+  description: string
+  conditions?: CategoryCondition
+  products?: string[]
+  filters?: CategoryFilter[]
+  createdAt: Date
+  updatedAt: Date
+  shop: Shops
+  published: boolean
+
+  identifierFields(): NonFunctionPropertyNames<Category>[] {
+    return ['id']
+  }
+}

package/src/domain/catalog/models/enums/index.ts

@@ -0,0 +1 @@
+export * from './shops.enum'

package/src/domain/catalog/models/enums/shops.enum.ts

@@ -0,0 +1,5 @@
+export enum Shops {
+  MENSMARKET = `mensmarket`,
+  GLAMSHOP = 'Glamshop',
+  GLAMPOINTS = 'Glampoints'
+}

package/src/domain/catalog/models/index.ts

@@ -0,0 +1,5 @@
+export * from './enums'
+export * from './types'
+export * from './category'
+export * from './product'
+export * from './variant'

package/src/domain/catalog/models/product.ts

@@ -0,0 +1,47 @@
+import { BaseModel, IdentifierFields, NonFunctionPropertyNames } from '../../general/model'
+
+import { Shops } from './enums/shops.enum'
+import { ProductReview, ShopDescription, ShopPrice, ShopsDescription, ShopsPrice, Stock } from './types'
+import { Variant } from './variant'
+
+export class Product extends BaseModel<Product> implements IdentifierFields<Product> {
+  id: string
+  name: string
+  slug: string
+  shopAvailability: Shops[]
+  description: ShopsDescription
+  sku: string
+  price: ShopsPrice
+  hasVariants: boolean
+  NCM: string
+  EAN: string
+  CEST: string
+  weight: number
+  stock: Stock
+  costPrice: number
+  images?: string[]
+  miniatures?: string[]
+  published: boolean
+  publishedGlam: boolean
+  createdAt: Date
+  updatedAt: Date
+  brand: string
+  tags?: string[]
+  type?: string
+  categories?: string[]
+  reviews?: ProductReview[]
+  variant?: Variant
+  video?: string
+
+  identifierFields(): NonFunctionPropertyNames<Product>[] {
+    return ['id']
+  }
+
+  getInfoByShop(shop: Shops): ShopDescription & ShopPrice & Stock {
+    return {
+      ...(this.description?.[shop]?.description ? { description: this.description?.[shop]?.description } : {}),
+      ...(this.price?.[shop] || {}),
+      ...(this.stock?.[shop] || {}),
+    }
+  }
+}

package/src/domain/catalog/models/types/category-condition.type.ts

@@ -0,0 +1,4 @@
+export type CategoryCondition = {
+  tags?: string[]
+  brand?: string
+}

package/src/domain/catalog/models/types/category-filter.type.ts

@@ -0,0 +1,4 @@
+export type CategoryFilter = {
+  name?: string
+  tags?: string[]
+}

package/src/domain/catalog/models/types/index.ts

@@ -0,0 +1,7 @@
+export * from './shops-description.type'
+export * from './shops-price.type'
+export * from './stock.type'
+export * from './category-condition.type'
+export * from './category-filter.type'
+export * from './product-review.type'
+export * from './variant-grade.type'

package/src/domain/catalog/models/types/product-review.type.ts

@@ -0,0 +1,16 @@
+import { Shops } from '../enums/shops.enum'
+
+export type ProductReview = {
+  author: string
+  createdAt: Date
+  email: string
+  location: string
+  rate: number
+  review: string
+  status: boolean
+  title: string
+  shop?: Shops
+  personId?: number
+  points?: number
+  orderId?: string
+}

package/src/domain/catalog/models/types/shops-description.type.ts

@@ -0,0 +1,9 @@
+import { Shops } from '../enums/shops.enum'
+
+export type ShopDescription = {
+  description: string
+}
+
+export type ShopsDescription = {
+  [K in Shops]?: ShopDescription
+}

package/src/domain/catalog/models/types/shops-price.type.ts

@@ -0,0 +1,12 @@
+import { Shops } from '../enums/shops.enum'
+
+export type ShopPrice = {
+  price: number
+  fullPrice: number
+  subscriberDiscountPercentage?: number
+  subscriberPrice?: number
+}
+
+export type ShopsPrice = {
+  [K in Shops]?: ShopPrice
+}

package/src/domain/catalog/models/types/stock.type.ts

@@ -0,0 +1,3 @@
+export type Stock = {
+  quantity: number
+}

package/src/domain/catalog/models/types/variant-grade.type.ts

@@ -0,0 +1,4 @@
+export type VariantGrade = {
+  title: string
+  value: string
+}

package/src/domain/catalog/models/variant.ts

@@ -0,0 +1,19 @@
+import { BaseModel, IdentifierFields, NonFunctionPropertyNames } from '../../general/model'
+
+import { ShopsPrice, Stock, VariantGrade } from './types'
+
+export class Variant extends BaseModel<Variant> implements IdentifierFields<Variant> {
+  id: string
+  productId: string
+  sku: string
+  price: ShopsPrice
+  EAN: string
+  stock: Stock
+  grade: VariantGrade[]
+  costPrice: number
+  weight: number
+
+  identifierFields(): NonFunctionPropertyNames<Variant>[] {
+    return ['id']
+  }
+}

package/src/domain/catalog/repositories/category.repository.ts

@@ -0,0 +1,10 @@
+import { Category } from '../models/category'
+import { CrudRepository } from '../../general/repository/crud.repository'
+import { Shops } from '../models/enums/shops.enum'
+import { Product } from '../models'
+
+export interface CategoryRepository extends CrudRepository<Category> {
+  getCategoryBySlug(slug: string, shop: Shops): Promise<Category>
+  getCategoriesForHome(categoryIds: string[], limit?: number): Promise<{ category: Category; products: Product[] }[]>
+  mountCategory(category: Category, options?: { limit?: number; hasStock?: boolean }): Promise<Product[]>
+}

package/src/domain/catalog/repositories/index.ts

@@ -0,0 +1,4 @@
+export * from './category.repository'
+export * from './product.repository'
+export * from './subscription-product.repository'
+export * from './variant.repository'

package/{domain/catalog/repositories/product.repository.d.ts → src/domain/catalog/repositories/product.repository.ts}

@@ -1,5 +1,6 @@
-import { CrudRepository } from '../../general/repository/crud.repository';
-import { Product, Shops } from '../models';
-export interface ProductRepository extends CrudRepository<Product> {
-    getBySlug(slug: string, shop: Shops): Promise<Product>;
-}
+import { CrudRepository } from '../../general/repository/crud.repository'
+import { Product, Shops } from '../models'
+
+export interface ProductRepository extends CrudRepository<Product> {
+  getBySlug(slug: string, shop: Shops): Promise<Product>
+}

package/{domain/catalog/repositories/subscription-product.repository.d.ts → src/domain/catalog/repositories/subscription-product.repository.ts}

@@ -1,4 +1,4 @@
-import { CrudRepository } from '../../general/repository/crud.repository';
-import { Product } from '../models';
-export interface SubscriptionProductRepository extends CrudRepository<Product> {
-}
+import { CrudRepository } from '../../general/repository/crud.repository'
+import { Product } from '../models'
+
+export interface SubscriptionProductRepository extends CrudRepository<Product> {}

package/{domain/catalog/repositories/variant.repository.d.ts → src/domain/catalog/repositories/variant.repository.ts}

@@ -1,4 +1,4 @@
-import { CrudRepository } from '../../general/repository/crud.repository';
-import { Variant } from '../models/variant';
-export interface VariantRepository extends CrudRepository<Variant> {
-}
+import { CrudRepository } from '../../general/repository/crud.repository'
+import { Variant } from '../models/variant'
+
+export interface VariantRepository extends CrudRepository<Variant> {}

package/src/domain/general/index.ts

@@ -0,0 +1,2 @@
+export * from './model'
+export * from './repository'

package/src/domain/general/model/base-model-with-identifier-fields.ts

@@ -0,0 +1,4 @@
+import { BaseModel } from './base.model'
+import { IdentifierFields } from './identifier-fields'
+
+export type BaseModelWithIdentifier<Model> = BaseModel<Model> & IdentifierFields<Model>

package/src/domain/general/model/base.model.ts

@@ -0,0 +1,17 @@
+import { plainToClass, classToPlain } from 'class-transformer'
+
+import { NonFunctionProperties } from './types/non-function-properties.type'
+
+export class BaseModel<Model> {
+  constructor(args?: Partial<Model>) {
+    Object.assign(this, args)
+  }
+
+  static toInstance<T>(this: new () => Partial<T>, data: NonFunctionProperties<T>): T {
+    return plainToClass(this, data) as any
+  }
+
+  toPlain(): any {
+    return classToPlain(this, { exposeUnsetFields: false })
+  }
+}

package/{domain/general/model/identifier-fields.d.ts → src/domain/general/model/identifier-fields.ts}

@@ -1,4 +1,5 @@
-import { NonFunctionPropertyNames } from './types/non-function-property-name.type';
-export interface IdentifierFields<Model> {
-    identifierFields: () => NonFunctionPropertyNames<Model>[];
-}
+import { NonFunctionPropertyNames } from './types/non-function-property-name.type'
+
+export interface IdentifierFields<Model> {
+  identifierFields: () => NonFunctionPropertyNames<Model>[]
+}

package/src/domain/general/model/index.ts

@@ -0,0 +1,4 @@
+export * from './base.model'
+export * from './identifier-fields'
+export * from './base-model-with-identifier-fields'
+export * from './types'

package/src/domain/general/model/types/base-model-builder.type.ts

@@ -0,0 +1,6 @@
+import { NonFunctionProperties } from './non-function-properties.type'
+
+export interface BaseModelBuilder<T> {
+  new (...args): T
+  toInstance(this: new () => T, data: NonFunctionProperties<T>): T
+}

package/src/domain/general/model/types/index.ts

@@ -0,0 +1,3 @@
+export * from './non-function-property-name.type'
+export * from './non-function-properties.type'
+export * from './base-model-builder.type'

package/src/domain/general/model/types/non-function-properties.type.ts

@@ -0,0 +1,3 @@
+import { NonFunctionPropertyNames } from './non-function-property-name.type'
+
+export type NonFunctionProperties<T> = Pick<Partial<T>, NonFunctionPropertyNames<T>>

package/src/domain/general/model/types/non-function-property-name.type.ts

@@ -0,0 +1 @@
+export type NonFunctionPropertyNames<T> = { [K in keyof T]: T[K] extends () => void ? never : K }[keyof T]

package/{domain/general/repository/create.repository.d.ts → src/domain/general/repository/create.repository.ts}

@@ -1,5 +1,6 @@
-import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields';
-import { NonFunctionProperties } from '../model/types/non-function-properties.type';
-export interface CreateRepository<Model extends BaseModelWithIdentifier<Model>> {
-    create(data: NonFunctionProperties<BaseModelWithIdentifier<Model>>): Promise<Model>;
-}
+import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields'
+import { NonFunctionProperties } from '../model/types/non-function-properties.type'
+
+export interface CreateRepository<Model extends BaseModelWithIdentifier<Model>> {
+  create(data: NonFunctionProperties<BaseModelWithIdentifier<Model>>): Promise<Model>
+}

package/src/domain/general/repository/crud.repository.ts

@@ -0,0 +1,12 @@
+import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields'
+
+import { CreateRepository } from './create.repository'
+import { DeleteRepository } from './delete.repository'
+import { ReadRepository } from './read.repository'
+import { UpdateRepository } from './update.repository'
+
+export interface CrudRepository<Model extends BaseModelWithIdentifier<Model>>
+  extends CreateRepository<Model>,
+    DeleteRepository<Model>,
+    ReadRepository<Model>,
+    UpdateRepository<Model> {}

package/{domain/general/repository/delete.repository.d.ts → src/domain/general/repository/delete.repository.ts}

@@ -1,5 +1,6 @@
-import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields';
-import { NonFunctionProperties } from '../model/types/non-function-properties.type';
-export interface DeleteRepository<Model extends BaseModelWithIdentifier<Model>> {
-    delete(identifiers: NonFunctionProperties<BaseModelWithIdentifier<Model>>): Promise<void>;
-}
+import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields'
+import { NonFunctionProperties } from '../model/types/non-function-properties.type'
+
+export interface DeleteRepository<Model extends BaseModelWithIdentifier<Model>> {
+  delete(identifiers: NonFunctionProperties<BaseModelWithIdentifier<Model>>): Promise<void>
+}

package/src/domain/general/repository/enums/index.ts

@@ -0,0 +1,2 @@
+export * from './where.enum'
+export * from './update-option-actions.enum'

package/src/domain/general/repository/enums/update-option-actions.enum.ts

@@ -0,0 +1,7 @@
+export enum UpdateOptionActions {
+  UPDATE = 'update',
+  MERGE = 'merge',
+  REMOVE = 'remove',
+  REMOVE_FIELD = 'removeField',
+  NULL = 'null',
+}

package/src/domain/general/repository/enums/where.enum.ts

@@ -0,0 +1,10 @@
+export enum Where {
+  EQUALS = '==',
+  NOTEQUALS = '!=',
+  GT = '>',
+  GTE = '>=',
+  IN = 'in',
+  LT = '<',
+  LTE = '<=',
+  LIKE = 'like',
+}

package/src/domain/general/repository/find.repository.ts

@@ -0,0 +1,11 @@
+import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields'
+
+import { RepositoryFindFielters, RepositoryFindResult, RepositoryLimitOptions, RepositoryOrderByList } from './types'
+
+export interface FindRepository<Model extends BaseModelWithIdentifier<Model>> {
+  find(
+    filters?: RepositoryFindFielters<Model>[],
+    limits?: RepositoryLimitOptions<Model>,
+    orderBy?: RepositoryOrderByList<Model>,
+  ): Promise<RepositoryFindResult<Model>>
+}

package/{domain/general/repository/get.repository.d.ts → src/domain/general/repository/get.repository.ts}

@@ -1,5 +1,6 @@
-import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields';
-import { NonFunctionProperties } from '../model/types/non-function-properties.type';
-export interface GetRepository<Model extends BaseModelWithIdentifier<Model>> {
-    get(identifiers: NonFunctionProperties<BaseModelWithIdentifier<Model>>): Promise<Model>;
-}
+import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields'
+import { NonFunctionProperties } from '../model/types/non-function-properties.type'
+
+export interface GetRepository<Model extends BaseModelWithIdentifier<Model>> {
+  get(identifiers: NonFunctionProperties<BaseModelWithIdentifier<Model>>): Promise<Model>
+}

package/src/domain/general/repository/index.ts

@@ -0,0 +1,9 @@
+export * from './enums'
+export * from './types'
+export * from './create.repository'
+export * from './get.repository'
+export * from './delete.repository'
+export * from './update.repository'
+export * from './find.repository'
+export * from './read.repository'
+export * from './crud.repository'

package/src/domain/general/repository/read.repository.ts

@@ -0,0 +1,8 @@
+import { BaseModelWithIdentifier } from '../model/base-model-with-identifier-fields'
+
+import { FindRepository } from './find.repository'
+import { GetRepository } from './get.repository'
+
+export interface ReadRepository<Model extends BaseModelWithIdentifier<Model>>
+  extends FindRepository<Model>,
+    GetRepository<Model> {}

package/src/domain/general/repository/types/index.ts

@@ -0,0 +1,5 @@
+export * from './repository-find-filters.type'
+export * from './repository-order-by-list.type'
+export * from './repository-limit-options.type'
+export * from './repository-find-result.type'
+export * from './repository-update-params.type'

package/src/domain/general/repository/types/repository-find-filters.type.ts

@@ -0,0 +1,21 @@
+import { NonFunctionPropertyNames } from '../../model/types/non-function-property-name.type'
+import { PropType } from '../../../../utils'
+import { Where } from '../enums/where.enum'
+
+export type RepositoryFindFieltersOptions<Model, FieldName extends keyof Model> = {
+  operator: Where
+  value: PropType<Model, FieldName> | PropType<Model, FieldName>[]
+}
+
+export type NestedRepositoryFindFieltersOptions<Model> = {
+  [key in NonFunctionPropertyNames<Model>]?: RepositoryFindFieltersOptions<Model, key>
+}
+
+export type RepositoryFindField<Model, FieldName extends keyof Model> =
+  | RepositoryFindFieltersOptions<Model, FieldName>
+  | Partial<PropType<Model, FieldName>>
+  | NestedRepositoryFindFieltersOptions<PropType<Model, FieldName>>
+
+export type RepositoryFindFielters<Model> = {
+  [key in NonFunctionPropertyNames<Model>]?: RepositoryFindField<Model, key>
+}

package/src/domain/general/repository/types/repository-find-result.type.ts

@@ -0,0 +1,4 @@
+export type RepositoryFindResult<Model> = {
+  data: Model[]
+  count: number
+}

package/src/domain/general/repository/types/repository-limit-options.type.ts

@@ -0,0 +1,4 @@
+export type RepositoryLimitOptions<Model> = {
+  offset?: number | string | Model
+  limit?: number
+}

package/src/domain/general/repository/types/repository-order-by-list.type.ts

@@ -0,0 +1,7 @@
+import { NonFunctionPropertyNames } from '../../model/types/non-function-property-name.type'
+
+export type RepositoryOrderBy<Model> = {
+  [key in NonFunctionPropertyNames<Model>]?: 'asc' | 'desc'
+}
+
+export type RepositoryOrderByList<Model> = RepositoryOrderBy<Model>[]