@unchainedshop/api 2.0.0-rc.3 → 2.0.0

package/src/resolvers/type/token-types.ts

@@ -1,8 +1,8 @@
-import { Context } from '@unchainedshop/types/api';
-import { Product } from '@unchainedshop/types/products';
-import { User } from '@unchainedshop/types/user';
-import { TokenStatus, TokenSurrogate } from '@unchainedshop/types/warehousing';
-import { WorkStatus } from '@unchainedshop/types/worker';
+import { Context } from '@unchainedshop/types/api.js';
+import { Product } from '@unchainedshop/types/products.js';
+import { User } from '@unchainedshop/types/user.js';
+import { TokenStatus, TokenSurrogate } from '@unchainedshop/types/warehousing.js';
+import { WorkStatus } from '@unchainedshop/types/worker.js';
 import localePkg from 'locale';
 
 const { Locale } = localePkg;

package/src/resolvers/type/user-types.ts

@@ -1,25 +1,26 @@
-import { Context, SortOption } from '@unchainedshop/types/api';
-import { Bookmark } from '@unchainedshop/types/bookmarks';
-import { Contact } from '@unchainedshop/types/common';
-import { Country } from '@unchainedshop/types/countries';
-import { Enrollment } from '@unchainedshop/types/enrollments';
-import { File } from '@unchainedshop/types/files';
-import { Language } from '@unchainedshop/types/languages';
-import { Order } from '@unchainedshop/types/orders';
-import { PaymentCredentials } from '@unchainedshop/types/payments';
-import { Quotation } from '@unchainedshop/types/quotations';
+import { Context, SortOption } from '@unchainedshop/types/api.js';
+import { Bookmark } from '@unchainedshop/types/bookmarks.js';
+import { Contact } from '@unchainedshop/types/common.js';
+import { Country } from '@unchainedshop/types/countries.js';
+import { Enrollment, EnrollmentStatus } from '@unchainedshop/types/enrollments.js';
+import { File } from '@unchainedshop/types/files.js';
+import { Language } from '@unchainedshop/types/languages.js';
+import { Order } from '@unchainedshop/types/orders.js';
+import { PaymentCredentials } from '@unchainedshop/types/payments.js';
+import { Quotation } from '@unchainedshop/types/quotations.js';
 import {
   Email,
   User as UserType,
   UserProfile,
   Web3Address,
   WebAuthnCredentials,
-} from '@unchainedshop/types/user';
+  PushSubscription,
+} from '@unchainedshop/types/user.js';
 import type { Locale } from 'locale';
-import { TokenSurrogate } from '@unchainedshop/types/warehousing';
+import { TokenSurrogate } from '@unchainedshop/types/warehousing.js';
 import { Roles, permissions } from '@unchainedshop/roles';
-import { checkAction, checkTypeResolver } from '../../acl';
-import { actions } from '../../roles';
+import { checkAction, checkTypeResolver } from '../../acl.js';
+import { actions } from '../../roles/index.js';
 
 type HelperType<P, T> = (user: UserType, params: P, context: Context) => Promise<T>;
 
@@ -33,7 +34,16 @@ export interface UserHelperTypes {
   cart: HelperType<{ orderNumber?: string }, Order>;
   country: HelperType<{ localeContext: Locale }, Country>;
   emails: HelperType<any, Array<string>>;
-  enrollments: HelperType<{ sort?: Array<SortOption>; queryString?: string }, Array<Enrollment>>;
+  enrollments: HelperType<
+    {
+      sort?: Array<SortOption>;
+      queryString?: string;
+      limit?: number;
+      offset?: number;
+      status?: Array<EnrollmentStatus>;
+    },
+    Array<Enrollment>
+  >;
   isGuest: HelperType<any, boolean>;
   isInitialPassword: HelperType<any, boolean>;
   isTwoFactorEnabled: HelperType<any, boolean>;
@@ -45,7 +55,15 @@ export interface UserHelperTypes {
   // locale: HelperType<{ localeContext: Locale }, Locale>;
   name: HelperType<any, string>;
   orders: HelperType<
-    { includeCarts: boolean; sort?: Array<SortOption>; queryString?: string },
+    {
+      includeCarts: boolean;
+      sort?: Array<SortOption>;
+      queryString?: string;
+      status?: string;
+      userId?: string;
+      limit?: number;
+      offset?: number;
+    },
     Array<Order>
   >;
   paymentCredentials: HelperType<any, Array<PaymentCredentials>>;
@@ -54,10 +72,14 @@ export interface UserHelperTypes {
   web3Addresses: HelperType<any, Array<Web3Address>>;
   primaryEmail: HelperType<any, Email>;
   profile: HelperType<any, UserProfile>;
-  quotations: HelperType<{ sort?: Array<SortOption>; queryString?: string }, Array<Quotation>>;
+  quotations: HelperType<
+    { sort?: Array<SortOption>; queryString?: string; userId?: string; limit?: number; offset?: number },
+    Array<Quotation>
+  >;
   roles: HelperType<any, Array<string>>;
   tags: HelperType<any, Array<string>>;
   username: HelperType<any, string>;
+  pushSubscriptions: HelperType<any, Array<PushSubscription>>;
 }
 
 const {
@@ -147,6 +169,7 @@ export const User: UserHelperTypes = {
   enrollments: async (user, params, context) => {
     await checkAction(context, viewUserEnrollments, [user, params]);
     return context.modules.enrollments.findEnrollments({
+      ...(params || {}),
       userId: user._id,
     });
   },
@@ -166,10 +189,8 @@ export const User: UserHelperTypes = {
   orders: async (user, params, context) => {
     await checkAction(context, viewUserOrders, [user, params]);
     return context.modules.orders.findOrders({
+      ...(params || {}),
       userId: user._id,
-      includeCarts: params.includeCarts,
-      sort: params.sort,
-      queryString: params.queryString,
     });
   },
 
@@ -198,9 +219,17 @@ export const User: UserHelperTypes = {
   quotations: async (user, params, context) => {
     await checkAction(context, viewUserQuotations, [user, params]);
     return context.modules.quotations.findQuotations({
+      ...(params || {}),
       userId: user._id,
-      sort: params.sort,
-      queryString: params.queryString,
     });
   },
+  pushSubscriptions: async (user, _, context) => {
+    await checkAction(context, viewUserPrivateInfos, [user]);
+    return (user?.pushSubscriptions || []).map(({ keys, userAgent, expirationTime, endpoint }) => ({
+      _id: keys.p256dh,
+      userAgent,
+      expirationTime,
+      endpoint,
+    }));
+  },
 };

package/src/resolvers/type/warehousing-provider-types.ts

@@ -1,4 +1,4 @@
-import { WarehousingProviderHelperTypes } from '@unchainedshop/types/warehousing';
+import { WarehousingProviderHelperTypes } from '@unchainedshop/types/warehousing.js';
 
 export const WarehousingProvider: WarehousingProviderHelperTypes = {
   interface(obj, _, context) {

package/src/resolvers/type/webauthn-credentials-types.ts

@@ -1,5 +1,5 @@
-import { Context } from '@unchainedshop/types/api';
-import { WebAuthnCredentials as WebAuthnCredentialsTypes } from '@unchainedshop/types/user';
+import { Context } from '@unchainedshop/types/api.js';
+import { WebAuthnCredentials as WebAuthnCredentialsTypes } from '@unchainedshop/types/user.js';
 
 type HelperType<P, T> = (
   credentials: WebAuthnCredentialsTypes,

package/src/resolvers/type/work-types.ts

@@ -1,5 +1,5 @@
-import { Context } from '@unchainedshop/types/api';
-import { Work as WorkType } from '@unchainedshop/types/worker';
+import { Context } from '@unchainedshop/types/api.js';
+import { Work as WorkType } from '@unchainedshop/types/worker.js';
 
 type HelperType<P, T> = (work: WorkType, params: P, context: Context) => T;
 

package/src/roles/index.ts

@@ -1,8 +1,8 @@
 import { Roles, Role } from '@unchainedshop/roles';
 
-import { all } from './all';
-import { loggedIn } from './loggedIn';
-import { admin } from './admin';
+import { all } from './all.js';
+import { loggedIn } from './loggedIn.js';
+import { admin } from './admin.js';
 
 const roles = {
   ADMIN: Roles.adminRole,

package/src/roles/loggedIn.ts

@@ -1,5 +1,5 @@
-import { Context } from '@unchainedshop/types/api';
-import { User } from '@unchainedshop/types/user';
+import { Context } from '@unchainedshop/types/api.js';
+import { User } from '@unchainedshop/types/user.js';
 
 export const loggedIn = (role: any, actions: Record<string, string>) => {
   const isMyself = (

package/src/schema/{index.js → index.ts}

@@ -1,9 +1,9 @@
-import scalars from './scalars';
-import directives from './directives';
-import types from './types';
-import inputTypes from './inputTypes';
-import query from './query';
-import mutation from './mutation';
+import scalars from './scalars.js';
+import directives from './directives.js';
+import types from './types/index.js';
+import inputTypes from './inputTypes.js';
+import query from './query.js';
+import mutation from './mutation.js';
 
 export const buildDefaultTypeDefs = ({ actions = [], events = [], workTypes = [] }) => {
   const dynamicTypeDefs = `

package/src/schema/{mutation.js → mutation.ts}

@@ -885,6 +885,16 @@ export default [
       Tokenize
       """
       exportToken(tokenId: ID!, quantity: Int! = 1, recipientWalletAddress: String!): Token!
+
+      """
+      Store user W3C Push subscription object
+      """
+      addPushSubscription(subscription: JSON!, unsubscribeFromOtherUsers: Boolean): User!
+
+      """
+      Remove user W3C push subscription object
+      """
+      removePushSubscription(p256dh: String!): User!
     }
   `,
 ];

package/src/schema/types/index.ts

@@ -0,0 +1,63 @@
+import address from './address.js';
+import assortment from './assortment.js';
+import color from './color.js';
+import contact from './contact.js';
+import country from './country.js';
+import currency from './currency.js';
+import delivery from './delivery.js';
+import dimensions from './dimensions.js';
+import discount from './discount.js';
+import dispatch from './dispatch.js';
+import filter from './filter.js';
+import language from './language.js';
+import media from './media.js';
+import price from './price.js';
+import payment from './payment.js';
+import shop from './shop.js';
+import stock from './stock.js';
+import types from './types.js';
+import user from './user.js';
+import warehousing from './warehousing.js';
+import order from './order/index.js';
+import product from './product/index.js';
+import quotation from './quotation.js';
+import geoposition from './geo-position.js';
+import bookmark from './bookmark.js';
+import search from './search.js';
+import worker from './worker.js';
+import enrollment from './enrollment.js';
+import events from './events.js';
+import files from './files.js';
+
+export default [
+  ...address,
+  ...assortment,
+  ...color,
+  ...contact,
+  ...country,
+  ...currency,
+  ...delivery,
+  ...dimensions,
+  ...discount,
+  ...dispatch,
+  ...filter,
+  ...language,
+  ...media,
+  ...price,
+  ...payment,
+  ...shop,
+  ...stock,
+  ...types,
+  ...user,
+  ...warehousing,
+  ...product,
+  ...order,
+  ...quotation,
+  ...geoposition,
+  ...bookmark,
+  ...search,
+  ...worker,
+  ...enrollment,
+  ...events,
+  ...files,
+];

package/src/schema/types/order/index.ts

@@ -0,0 +1,8 @@
+import order from './order.js';
+import delivery from './delivery.js';
+import discount from './discount.js';
+import item from './item.js';
+import payment from './payment.js';
+import pickupLocation from './pick-up-location.js';
+
+export default [...order, ...item, ...discount, ...delivery, ...payment, ...pickupLocation];

package/src/schema/types/product/index.ts

@@ -0,0 +1,15 @@
+import configurableProduct from './configurable-product.js';
+import simpleProduct from './simple-product.js';
+import product from './product.js';
+import bundleProduct from './bundle-product.js';
+import planProduct from './plan-product.js';
+import tokenizedProduct from './tokenized-product.js';
+
+export default [
+  ...product,
+  ...configurableProduct,
+  ...simpleProduct,
+  ...bundleProduct,
+  ...planProduct,
+  ...tokenizedProduct,
+];

package/src/schema/types/{shop.js → shop.ts}

@@ -4,6 +4,16 @@ export default [
       href: String
       title: String
     }
+
+    type AdminUiConfigCustomEntityInterface {
+      entityName: String!
+      inlineFragment: String!
+    }
+
+    type AdminUiConfig {
+      customProperties: [AdminUiConfigCustomEntityInterface!]!
+    }
+
     type Shop @cacheControl(maxAge: 180) {
       _id: ID!
       language: Language
@@ -11,6 +21,8 @@ export default [
       version: String
       userRoles: [String!]!
       externalLinks: [Link]!
+      adminUiConfig: AdminUiConfig!
+      vapidPublicKey: String
     }
   `,
 ];

package/src/schema/types/{user.js → user.ts}

@@ -27,6 +27,13 @@ export default [
       user: User
     }
 
+    type PushSubscription {
+      _id: ID!
+      userAgent: String
+      expirationTime: Timestamp
+      endpoint: String!
+    }
+
     type UserProfile {
       displayName: String
       phoneMobile: String
@@ -83,7 +90,6 @@ export default [
       nonce: Int
       verified: Boolean!
     }
-
     type User {
       _id: ID!
       created: DateTime!
@@ -95,6 +101,7 @@ export default [
       isInitialPassword: Boolean!
       webAuthnCredentials: [WebAuthnCredentials!]!
       web3Addresses: [Web3Address!]!
+      pushSubscriptions: [PushSubscription!]!
       name: String!
       avatar: Media
       profile: UserProfile
@@ -108,11 +115,28 @@ export default [
       roles: [String!]
       tags: [LowerCaseString!]
       cart(orderNumber: String): Order
-      orders(includeCarts: Boolean = false, sort: [SortOptionInput!], queryString: String): [Order!]!
-      quotations(sort: [SortOptionInput!], queryString: String): [Quotation!]!
+      orders(
+        limit: Int
+        offset: Int
+        queryString: String
+        sort: [SortOptionInput!]
+        includeCarts: Boolean = false
+      ): [Order!]!
+      quotations(
+        sort: [SortOptionInput!]
+        queryString: String
+        limit: Int = 10
+        offset: Int = 0
+      ): [Quotation!]!
       bookmarks: [Bookmark!]!
       paymentCredentials: [PaymentCredentials!]!
-      enrollments(sort: [SortOptionInput!], queryString: String): [Enrollment!]!
+      enrollments(
+        limit: Int
+        offset: Int
+        queryString: String
+        status: [String!]
+        sort: [SortOptionInput!]
+      ): [Enrollment!]!
       allowedActions: [RoleAction!]!
       tokens: [Token!]!
     }

package/src/user-context.ts

@@ -1,5 +1,5 @@
-import { UnchainedUserContext } from '@unchainedshop/types/api';
-import { UnchainedCore } from '@unchainedshop/types/core';
+import { UnchainedUserContext } from '@unchainedshop/types/api.js';
+import { UnchainedCore } from '@unchainedshop/types/core.js';
 import { IncomingMessage, OutgoingMessage } from 'http';
 import cookie from 'cookie';
 

package/tests/api-index.test.ts

@@ -1,16 +1,15 @@
 // Import the function to be tested.
-import {admin} from '../src/roles/admin'
-import {actions} from '../src/roles';
-import {jest} from '@jest/globals'
-import {checkAction, ensureActionExists, ensureIsFunction} from '../src/acl'
-import { NoPermissionError, PermissionSystemError } from '../src/errors';
+import {admin} from '../lib/roles/admin.js'
+import {actions} from '../lib/roles/index.js';
+import {checkAction, ensureActionExists, ensureIsFunction} from '../lib/acl.js'
+import { NoPermissionError, PermissionSystemError } from '../lib/errors.js';
 import { Roles } from '@unchainedshop/roles';
 
 describe('API', () => {
 
   describe('roles', () => {
     const role = {
-      allow: jest.fn()
+      allow: import.meta.jest.fn()
     };
 
     it('creates the admin role and grants permissions to all actions', () => {
@@ -52,7 +51,7 @@ describe('API', () => {
   describe('checkAction', () => {
     
   it('should throw a NoPermissionError if the user does not have permission to perform the action', async () => {
-    Roles.userHasPermission = jest.fn(async () => false);
+    Roles.userHasPermission = import.meta.jest.fn(async () => false);
 
     const context = { userId: '123' };
     const action = 'some action';
@@ -63,7 +62,7 @@ describe('API', () => {
   });
   
   it('should not throw an error if the user has permission to perform the action', async () => {
-    Roles.userHasPermission = jest.fn(async () => true);
+    Roles.userHasPermission = import.meta.jest.fn(async () => true);
     const context = { userId: '123' };
     const action = 'some action';
     const args: any = {};

package/tsconfig.json

@@ -1,30 +1,11 @@
 {
+  "extends": "../shared/base.tsconfig.json",
   "compilerOptions": {
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "experimentalDecorators": true,
-    "forceConsistentCasingInFileNames": true,
-    "lib": [
-      "esnext"
-    ],
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noImplicitReturns": true,
-    "noUnusedLocals": false,
+    "rootDir": "src",
     "outDir": "lib",
-    "preserveWatchOutput": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "target": "esnext",
-    "types": [
-      "node",
-      "jest"
-    ]
   },
+  "exclude": ["**/*.test.ts", "**/*.test.js", "tests"],
   "include": [
-    "src"
+    "./src"
   ]
 }