npm - @unchainedshop/api - Versions diffs - 2.0.0-beta7 → 2.0.0-beta9 - Mend

@unchainedshop/api 2.0.0-beta7 → 2.0.0-beta9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (565) hide show

package/src/schema/directives.js ADDED Viewed

@@ -0,0 +1,14 @@
+export default [
+  /* GraphQL */ `
+    enum CacheControlScope {
+      PUBLIC
+      PRIVATE
+    }
+    directive @cacheControl(
+      maxAge: Int
+      scope: CacheControlScope
+      inheritMaxAge: Boolean
+    ) on FIELD_DEFINITION | OBJECT | INTERFACE | UNION
+  `,
+];

package/src/schema/index.js CHANGED Viewed

@@ -1,7 +1,8 @@
 import scalars from './scalars';
+import directives from './directives';
 import types from './types';
 import inputTypes from './inputTypes';
 import query from './query';
 import mutation from './mutation';
-export default [...scalars, ...types, ...inputTypes, ...query, ...mutation];
+export default [...scalars, ...directives, ...types, ...inputTypes, ...query, ...mutation];

package/src/schema/inputTypes.js CHANGED Viewed

@@ -1,20 +1,5 @@
 export default [
   /* GraphQL */ `
-    """
-    A hashed password
-    """
-    input HashedPasswordInput {
-      """
-      The hashed password
-      """
-      digest: String!
-      """
-      Algorithm used to hash the password
-      """
-      algorithm: String!
-    }
     input SortOptionInput {
       key: String!
       value: SortDirection!

package/src/schema/mutation.js CHANGED Viewed

@@ -8,7 +8,6 @@ export default [
       loginWithPassword(
         username: String
         email: String
-        password: HashedPasswordInput
         plainPassword: String
         totpCode: String
       ): LoginMethodResponse
@@ -21,9 +20,9 @@ export default [
       """
       Web3
       """
-      addWeb3Address(address: String!): User
-      verifyWeb3Address(address: String!, hash: String!): User
-      removeWeb3Address(address: String!): User
+      addWeb3Address(address: String!): User!
+      verifyWeb3Address(address: String!, hash: String!): User!
+      removeWeb3Address(address: String!): User!
       """
       Create a new user.
@@ -31,10 +30,6 @@ export default [
       createUser(
         username: String
         email: String
-        password: HashedPasswordInput
-          @deprecated(
-            reason: "Use plainPassword, there is not a lot of added security by hashing on the client"
-          )
         webAuthnPublicKeyCredentials: JSON
         plainPassword: String
         profile: UserProfileInput
@@ -45,17 +40,12 @@ export default [
       login and logged in user IP address, locale and country where they
       accessed the system)
       """
-      heartbeat: User
+      heartbeat: User!
       """
       Change the current user's password. Must be logged in.
       """
-      changePassword(
-        oldPassword: HashedPasswordInput
-        oldPlainPassword: String
-        newPassword: HashedPasswordInput
-        newPlainPassword: String
-      ): SuccessResponse
+      changePassword(oldPlainPassword: String, newPlainPassword: String): SuccessResponse
       """
       Request a forgot password email.
@@ -65,11 +55,7 @@ export default [
       """
       Reset the password for a user using a token received in email. Logs the user in afterwards.
       """
-      resetPassword(
-        newPlainPassword: String
-        newPassword: HashedPasswordInput
-        token: String!
-      ): LoginMethodResponse
+      resetPassword(newPlainPassword: String, token: String!): LoginMethodResponse
       """
       Log the user out.
@@ -104,12 +90,12 @@ export default [
       """
       In order to activate 2nd factor (TOTP), generate a secret and return
       """
-      enableTOTP(secretBase32: String!, code: String!): User
+      enableTOTP(secretBase32: String!, code: String!): User!
       """
       Disable the 2nd factor (TOTP)
       """
-      disableTOTP(code: String!, userId: ID): User
+      disableTOTP(code: String!, userId: ID): User!
       """
       Create WebAuthn PublicKeyCredentialCreationOptions to use for Registering a new WebAuthn Device
@@ -323,37 +309,37 @@ export default [
       """
       Update E-Mail address of any user or logged in user if userId is not provided
       """
-      addEmail(email: String!, userId: ID): User
+      addEmail(email: String!, userId: ID): User!
       """
       Update E-Mail address of any user or logged in user if userId is not provided
       """
-      removeEmail(email: String!, userId: ID): User
+      removeEmail(email: String!, userId: ID): User!
       """
       Update Avatar of any user or logged in user if userId is not provided
       """
-      updateUserAvatar(avatar: Upload!, userId: ID): User
+      updateUserAvatar(avatar: Upload!, userId: ID): User!
       """
       Set tags of user
       """
-      setUserTags(tags: [LowerCaseString]!, userId: ID!): User
+      setUserTags(tags: [LowerCaseString]!, userId: ID!): User!
       """
       Update Profile of any user or logged in user if userId is not provided
       """
-      updateUserProfile(profile: UserProfileInput, meta: JSON, userId: ID): User
+      updateUserProfile(profile: UserProfileInput, meta: JSON, userId: ID): User!
+      """
+      Remove any user or logged in user if userId is not provided
+      """
+      removeUser(userId: ID): User!
       """
       Enroll a new user, setting enroll to true will let the user choose his password (e-mail gets sent)
       """
-      enrollUser(
-        profile: UserProfileInput!
-        email: String!
-        password: HashedPasswordInput
-        plainPassword: String
-      ): User
+      enrollUser(profile: UserProfileInput!, email: String!, plainPassword: String): User!
       """
       Forcefully trigger an enrollment email for already added users by e-mail
@@ -363,17 +349,17 @@ export default [
       """
       Set username for a specific user
       """
-      setUsername(username: String!, userId: ID!): User
+      setUsername(username: String!, userId: ID!): User!
       """
       Set a new password for a specific user
       """
-      setPassword(newPassword: HashedPasswordInput, newPlainPassword: String, userId: ID!): User
+      setPassword(newPlainPassword: String, userId: ID!): User!
       """
       Set roles of a user
       """
-      setRoles(roles: [String!]!, userId: ID!): User
+      setRoles(roles: [String!]!, userId: ID!): User!
       """
       Create a new product

package/src/schema/query.js CHANGED Viewed

@@ -7,13 +7,14 @@ export default [
       me: User
       """
-      Get list of users
+      Get list of users, by default sorted by creation date (ascending) unless a queryString is set
       """
       users(
         limit: Int = 20
         offset: Int = 0
         includeGuests: Boolean = false
         queryString: String
+        sort: [SortOptionInput!]
       ): [User!]!
       """
@@ -35,11 +36,12 @@ export default [
         slugs: [String!]
         includeDrafts: Boolean = false
         queryString: String
-      ): Int!
+      ): Int! @cacheControl(maxAge: 180)
       """
       Simple list of published products filtered either by tags or explicit slugs
       If a slug is provided, limit and offset don't have any effect on the result
+      By default sorted by sequence (ascending) and published (ascending) unless a queryString is set
       """
       products(
         queryString: String
@@ -60,16 +62,18 @@ export default [
       List products specified prices
       """
       productCatalogPrices(productId: ID!): [ProductCatalogPrice!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Localization: Meta data for product
       """
-      translatedProductTexts(productId: ID!): [ProductTexts!]!
+      translatedProductTexts(productId: ID!): [ProductTexts!]! @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Localization: Media title/subtitle of a media that is attached to a product
       """
       translatedProductMediaTexts(productMediaId: ID!): [ProductMediaTexts!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Localization: Variations and Variation Options
@@ -77,15 +81,16 @@ export default [
       translatedProductVariationTexts(
         productVariationId: ID!
         productVariationOptionValue: String
-      ): [ProductVariationTexts!]!
+      ): [ProductVariationTexts!]! @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Returns total number languages
       """
       languagesCount(includeInactive: Boolean = false, queryString: String): Int!
+        @cacheControl(maxAge: 180)
       """
-      Get all languages
+      Get all languages, by default sorted by creation date (ascending)
       """
       languages(
         limit: Int = 50
@@ -101,7 +106,7 @@ export default [
       language(languageId: ID!): Language
       """
-      Get all countries
+      Get all countries, by default sorted by creation date (ascending)
       """
       countries(
         limit: Int = 50
@@ -115,6 +120,7 @@ export default [
       Returns total number of countries
       """
       countriesCount(includeInactive: Boolean = false, queryString: String): Int!
+        @cacheControl(maxAge: 180)
       """
       Get a specific country by ID
@@ -125,9 +131,10 @@ export default [
       Returns total number of currencies
       """
       currenciesCount(includeInactive: Boolean = false, queryString: String): Int!
+        @cacheControl(maxAge: 180)
       """
-      Get all currencies
+      Get all currencies, by default sorted by creation date (ascending)
       """
       currencies(
         limit: Int = 50
@@ -145,42 +152,49 @@ export default [
       """
       Returns total number of delivery providers, optionally filtered by type
       """
-      deliveryProvidersCount(type: DeliveryProviderType): Int!
+      deliveryProvidersCount(type: DeliveryProviderType): Int! @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get all delivery providers, optionally filtered by type
       """
       deliveryProviders(type: DeliveryProviderType): [DeliveryProvider!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get a specific delivery provider by ID
       """
       deliveryProvider(deliveryProviderId: ID!): DeliveryProvider
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get all delivery interfaces filtered by type
       """
       deliveryInterfaces(type: DeliveryProviderType!): [DeliveryInterface!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Returns total number of delivery providers, optionally filtered by type
       """
       warehousingProvidersCount(type: WarehousingProviderType): Int!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get all warehousing providers, optionally filtered by type
       """
       warehousingProviders(type: WarehousingProviderType): [WarehousingProvider!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get a specific warehousing provider by ID
       """
       warehousingProvider(warehousingProviderId: ID!): WarehousingProvider
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get all warehousing interfaces filtered by type
       """
       warehousingInterfaces(type: WarehousingProviderType!): [WarehousingInterface!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get token
@@ -190,22 +204,24 @@ export default [
       """
       Returns total number of payment providers, optionally filtered by type
       """
-      paymentProvidersCount(type: PaymentProviderType): Int!
+      paymentProvidersCount(type: PaymentProviderType): Int! @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get all payment providers, optionally filtered by type
       """
       paymentProviders(type: PaymentProviderType): [PaymentProvider!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get a specific payment provider by ID
       """
-      paymentProvider(paymentProviderId: ID!): PaymentProvider
+      paymentProvider(paymentProviderId: ID!): PaymentProvider @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get all payment interfaces filtered by type
       """
       paymentInterfaces(type: PaymentProviderType!): [PaymentInterface!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Returns total number of orders
@@ -213,7 +229,7 @@ export default [
       ordersCount(includeCarts: Boolean = false, queryString: String): Int!
       """
-      Get all orders
+      Get all orders, by default sorted by creation date (descending)
       """
       orders(
         limit: Int = 10
@@ -234,7 +250,7 @@ export default [
       shopInfo: Shop!
       """
-      Get all root assortments
+      Get all root assortments, by default sorted by sequence (ascending)
       """
       assortments(
         queryString: String
@@ -256,7 +272,7 @@ export default [
         includeInactive: Boolean = false
         includeLeaves: Boolean = false
         queryString: String
-      ): Int!
+      ): Int! @cacheControl(maxAge: 180)
       """
       Get a specific assortment by ID
@@ -267,24 +283,28 @@ export default [
       Localization: Meta data for assortments
       """
       translatedAssortmentTexts(assortmentId: ID!): [AssortmentTexts!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Localization: Media title/subtitle of a media that is attached to a assortment
       """
       translatedAssortmentMediaTexts(assortmentMediaId: ID!): [AssortmentMediaTexts!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Localization: Filters and Filter Options
       """
       translatedFilterTexts(filterId: ID!, filterOptionValue: String): [FilterTexts!]!
+        @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Returns total number of filters
       """
       filtersCount(includeInactive: Boolean = false, queryString: String): Int!
+        @cacheControl(maxAge: 180)
       """
-      Get all filters
+      Get all filters, by default sorted by creation date (ascending)
       """
       filters(
         limit: Int = 10
@@ -302,22 +322,22 @@ export default [
       """
       Returns total number of product reviews
       """
-      productReviewsCount(queryString: String): Int!
+      productReviewsCount(queryString: String): Int! @cacheControl(scope: PRIVATE, maxAge: 0)
       """
-      Get all product reviews
+      Get all product reviews, by default sorted by creation date (descending)
       """
       productReviews(
         limit: Int = 10
         offset: Int = 0
         sort: [SortOptionInput!]
         queryString: String
-      ): [ProductReview!]!
+      ): [ProductReview!]! @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Get a specific product review by ID
       """
-      productReview(productReviewId: ID!): ProductReview!
+      productReview(productReviewId: ID!): ProductReview! @cacheControl(scope: PRIVATE, maxAge: 0)
       """
       Returns total number of quotations
@@ -325,7 +345,7 @@ export default [
       quotationsCount(queryString: String): Int!
       """
-      Get all quotations
+      Get all quotations, by default sorted by creation date (ascending)
       """
       quotations(
         limit: Int = 10
@@ -345,7 +365,7 @@ export default [
       enrollmentsCount(queryString: String, status: [String!]): Int!
       """
-      Get all enrollments
+      Get all enrollments, by default sorted by creation date (ascending)
       """
       enrollments(
         limit: Int = 10
@@ -383,7 +403,7 @@ export default [
       ): AssortmentSearchResult!
       """
-      Get all work from the queue
+      Get all work from the queue, by default sorted by start date (desc), priority (desc), originalWorkId (asc) and created (asc)
       """
       workQueue(
         limit: Int = 10
@@ -420,7 +440,7 @@ export default [
       event(eventId: ID!): Event
       """
-      Get all emitted events
+      Get all emitted events, by default sorted by creation date (desc)
       """
       events(
         types: [String!]

package/src/schema/types/assortment.js CHANGED Viewed

@@ -1,13 +1,13 @@
 export default [
   /* GraphQL */ `
-    type AssortmentMediaTexts {
+    type AssortmentMediaTexts @cacheControl(maxAge: 180) {
       _id: ID!
       locale: String
       title: String
       subtitle: String
     }
-    type AssortmentMedia {
+    type AssortmentMedia @cacheControl(maxAge: 180) {
       _id: ID!
       tags: [LowerCaseString!]
       file: Media!
@@ -18,10 +18,11 @@ export default [
     """
     Assortment
     """
-    type Assortment {
+    type Assortment @cacheControl(maxAge: 180) {
       _id: ID!
       created: DateTime
       updated: DateTime
+      deleted: DateTime
       isActive: Boolean
       isBase: Boolean
       isRoot: Boolean
@@ -47,7 +48,7 @@ export default [
     """
     Directed assortment to product paths (breadcrumbs)
     """
-    type AssortmentPath {
+    type AssortmentPath @cacheControl(maxAge: 180) {
       links: [AssortmentPathLink!]!
     }
@@ -56,14 +57,13 @@ export default [
     assortmentId and assortmentTexts are there for convenience
     to short-circuit breadcrumb lookups
     """
-    type AssortmentPathLink {
+    type AssortmentPathLink @cacheControl(maxAge: 180) {
       assortmentId: ID!
-      assortmentSlug: String! @deprecated(reason: "Please use assortmentTexts")
       assortmentTexts(forceLocale: String): AssortmentTexts!
       link: AssortmentLink
     }
-    type AssortmentProduct {
+    type AssortmentProduct @cacheControl(maxAge: 180) {
       _id: ID!
       sortKey: Int!
       tags: [LowerCaseString!]
@@ -71,7 +71,7 @@ export default [
       product: Product!
     }
-    type AssortmentFilter {
+    type AssortmentFilter @cacheControl(maxAge: 180) {
       _id: ID!
       sortKey: Int!
       tags: [LowerCaseString!]
@@ -79,7 +79,7 @@ export default [
       filter: Filter!
     }
-    type AssortmentLink {
+    type AssortmentLink @cacheControl(maxAge: 180) {
       _id: ID!
       sortKey: Int!
       tags: [LowerCaseString!]
@@ -87,7 +87,7 @@ export default [
       child: Assortment!
     }
-    type AssortmentTexts {
+    type AssortmentTexts @cacheControl(maxAge: 180) {
       _id: ID!
       locale: String
       slug: String

package/src/schema/types/color.js CHANGED Viewed

@@ -1,6 +1,6 @@
 export default [
   /* GraphQL */ `
-    type Color {
+    type Color @cacheControl(maxAge: 180) {
       name: String
       hex: String
       red: Int

package/src/schema/types/country.js CHANGED Viewed

@@ -1,6 +1,6 @@
 export default [
   /* GraphQL */ `
-    type Country {
+    type Country @cacheControl(maxAge: 180) {
       _id: ID!
       """
       ISO 3166-1 alpha-2 https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements

package/src/schema/types/currency.js CHANGED Viewed

@@ -1,6 +1,6 @@
 export default [
   /* GraphQL */ `
-    type Currency {
+    type Currency @cacheControl(maxAge: 180) {
       _id: ID!
       isoCode: String!
       isActive: Boolean

package/src/schema/types/delivery.js CHANGED Viewed

@@ -1,6 +1,6 @@
 export default [
   /* GraphQL */ `
-    type DeliveryInterface {
+    type DeliveryInterface @cacheControl(maxAge: 180) {
       _id: ID!
       label: String
       version: String
@@ -25,7 +25,7 @@ export default [
       WRONG_CREDENTIALS
     }
-    type DeliveryProvider {
+    type DeliveryProvider @cacheControl(maxAge: 60) {
       _id: ID!
       created: DateTime
       updated: DateTime
@@ -36,6 +36,7 @@ export default [
       configurationError: DeliveryProviderError
       isActive: Boolean
       simulatedPrice(currency: String, useNetPrice: Boolean = false, orderId: ID, context: JSON): Price
+        @cacheControl(scope: PRIVATE, maxAge: 10)
     }
   `,
 ];

package/src/schema/types/dimensions.js CHANGED Viewed

@@ -12,7 +12,7 @@ export default [
       MILLIMETERS
     }
-    type Dimensions {
+    type Dimensions @cacheControl(maxAge: 180) {
       weight(unit: MassUnit = KILOGRAM): Float
       length(unit: LengthUnit = METERS): Float
       width(unit: LengthUnit = METERS): Float

package/src/schema/types/discount.js CHANGED Viewed

@@ -1,6 +1,6 @@
 export default [
   /* GraphQL */ `
-    type DiscountInterface {
+    type DiscountInterface @cacheControl(maxAge: 180) {
       _id: ID!
       label: String
       version: String

package/src/schema/types/filter.js CHANGED Viewed

@@ -22,20 +22,20 @@ export default [
       RANGE
     }
-    type FilterTexts {
+    type FilterTexts @cacheControl(maxAge: 180) {
       _id: ID!
       locale: String
       title: String
       subtitle: String
     }
-    type FilterOption {
+    type FilterOption @cacheControl(maxAge: 180) {
       _id: ID!
       texts(forceLocale: String): FilterTexts
       value: String
     }
-    type Filter {
+    type Filter @cacheControl(maxAge: 180) {
       _id: ID!
       updated: DateTime
       created: DateTime
@@ -46,17 +46,14 @@ export default [
       options: [FilterOption!]
     }
-    type LoadedFilterOption {
-      filteredProducts: Int! @deprecated(reason: "Renamed, use the filteredProductsCount field")
+    type LoadedFilterOption @cacheControl(maxAge: 180) {
       filteredProductsCount: Int!
       definition: FilterOption!
       isSelected: Boolean
     }
-    type LoadedFilter {
-      examinedProducts: Int! @deprecated(reason: "Renamed, use the productsCount field")
+    type LoadedFilter @cacheControl(maxAge: 180) {
       productsCount: Int!
-      filteredProducts: Int! @deprecated(reason: "Renamed, use the filteredProductsCount field")
       filteredProductsCount: Int!
       definition: Filter!
       isSelected: Boolean

package/src/schema/types/geo-position.js CHANGED Viewed

@@ -1,6 +1,6 @@
 export default [
   /* GraphQL */ `
-    type GeoPosition {
+    type GeoPosition @cacheControl(maxAge: 180) {
       latitude: Float!
       longitude: Float!
       altitute: Float