refactor: turn into dual node package with additional browser bundle

.circleci/config.yml

@@ -8,7 +8,7 @@ orbs:
 jobs:
   lint:
     docker:
-      - image: cimg/node:18.19-browsers
+      - image: 'cimg/node:18.20.1-browsers'
     steps:
       - checkout
       - vault/get-secrets: # Loads vault secrets
@@ -28,7 +28,7 @@ jobs:
     steps:
       - checkout
       - node/install:
-          node-version: '18.17'
+          node-version: '18.20.1'
       - vault/get-secrets: # Loads vault secrets
           template-preset: 'packages-read'
       - run: echo "//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_READ_TOKEN}" > ~/.npmrc
@@ -42,7 +42,7 @@ jobs:
     steps:
       - checkout
       - node/install:
-          node-version: '18.17'
+          node-version: '18.20.1'
       - vault/get-secrets: # Loads vault secrets
           template-preset: 'packages-read'
       - run: echo "//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_READ_TOKEN}" > ~/.npmrc
@@ -52,7 +52,7 @@ jobs:
 
   release:
     docker:
-      - image: cimg/node:18.19-browsers
+      - image: 'cimg/node:18.20.1-browsers'
     steps:
       - checkout
       - browser-tools/install-chrome

.eslintrc.js → .eslintrc.cjs

@@ -1,7 +1,7 @@
 module.exports = {
+  parser: '@typescript-eslint/parser',
   plugins: ['standard', 'promise'],
   env: {
-    jest: true,
     node: true,
   },
   globals: {
@@ -12,6 +12,7 @@ module.exports = {
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
     'prettier',
+    'plugin:vitest-globals/recommended',
   ],
   ignorePatterns: ['**/test/output-integration/**', '**/webpack.config.js'],
   rules: {

.gitignore

@@ -1,5 +1,6 @@
 dist
 gh-pages
+test/output-integration/browser/public/contentful*.js
 
 # Esdoc dirs
 out

.husky/pre-commit

@@ -0,0 +1,2 @@
+npm run lint
+npm run prettier:check

.husky/pre-push

@@ -0,0 +1 @@
+npm run test:prepush

lib/contentful.ts

@@ -3,13 +3,17 @@
  * with access to the Contentful Content Delivery API.
  */
 
-import type { AxiosAdapter, AxiosRequestConfig, AxiosResponse } from 'axios'
 import axios from 'axios'
+import type { AxiosAdapter, AxiosRequestConfig, AxiosResponse } from 'axios'
+
 import { createHttpClient, getUserAgentHeader } from 'contentful-sdk-core'
-import { createGlobalOptions } from './create-global-options'
-import { makeClient } from './make-client'
-import { ContentfulClientApi } from './types'
-import { validateRemoveUnresolvedParam, validateResolveLinksParam } from './utils/validate-params'
+import { createGlobalOptions } from './create-global-options.js'
+import { makeClient } from './make-client.js'
+import {
+  validateRemoveUnresolvedParam,
+  validateResolveLinksParam,
+} from './utils/validate-params.js'
+import type { ContentfulClientApi } from './types/client.js'
 
 /**
  * @category Client

lib/create-contentful-api.ts

@@ -6,38 +6,38 @@
 import { encodeCPAResponse } from '@contentful/content-source-maps'
 import { AxiosInstance, createRequestConfig, errorHandler } from 'contentful-sdk-core'
 import { CreateClientParams } from './contentful'
-import { GetGlobalOptions } from './create-global-options'
-import pagedSync from './paged-sync'
-import {
+import { GetGlobalOptions } from './create-global-options.js'
+import pagedSync from './paged-sync.js'
+import type {
   Asset,
   AssetCollection,
   AssetKey,
   ContentfulClientApi,
   ContentType,
   ContentTypeCollection,
-  EntryCollection,
-  EntrySkeletonType,
-  LocaleCode,
   LocaleCollection,
   Space,
-  SyncOptions,
-  SyncQuery,
   Tag,
   TagCollection,
-} from './types'
-import { ChainOptions, ModifiersFromOptions } from './utils/client-helpers'
-import normalizeSearchParameters from './utils/normalize-search-parameters'
-import normalizeSelect from './utils/normalize-select'
+  EntryCollection,
+  SyncQuery,
+  SyncOptions,
+  EntrySkeletonType,
+  LocaleCode,
+} from './types/index.js'
+import normalizeSearchParameters from './utils/normalize-search-parameters.js'
+import normalizeSelect from './utils/normalize-select.js'
+import resolveCircular from './utils/resolve-circular.js'
 import getQuerySelectionSet from './utils/query-selection-set'
-import resolveCircular from './utils/resolve-circular'
+import validateTimestamp from './utils/validate-timestamp.js'
+import { ChainOptions, ModifiersFromOptions } from './utils/client-helpers.js'
 import {
   checkIncludeContentSourceMapsParamIsAllowed,
   validateLocaleParam,
   validateRemoveUnresolvedParam,
   validateResolveLinksParam,
 } from './utils/validate-params'
 import validateSearchParameters from './utils/validate-search-parameters'
-import validateTimestamp from './utils/validate-timestamp'
 
 const ASSET_KEY_MAX_LIFETIME = 48 * 60 * 60
 
@@ -275,7 +275,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
       })
 
       return resolveCircular(entries, {
-        resolveLinks: !withoutLinkResolution ?? true,
+        resolveLinks: !withoutLinkResolution,
         removeUnresolved: withoutUnresolvableLinks ?? false,
       })
     } catch (error) {
@@ -462,7 +462,7 @@ export default function createContentfulApi<OptionType extends ChainOptions>(
     const { withoutLinkResolution, withoutUnresolvableLinks } = options
 
     return resolveCircular(data, {
-      resolveLinks: !withoutLinkResolution ?? true,
+      resolveLinks: !withoutLinkResolution,
       removeUnresolved: withoutUnresolvableLinks ?? false,
     })
   }

lib/index.ts

@@ -1,7 +1,7 @@
-export * from './contentful'
-export * from './create-global-options'
-export * from './mixins/stringify-safe'
-export * from './utils/normalize-select'
-export * from './utils/resolve-circular'
+export * from './contentful.js'
+export * from './create-global-options.js'
+export * from './mixins/stringify-safe.js'
+export * from './utils/normalize-select.js'
+export * from './utils/resolve-circular.js'
 
-export * from './types'
+export * from './types/index.js'

lib/make-client.ts

@@ -1,11 +1,11 @@
-import createContentfulApi, { CreateContentfulApiParams } from './create-contentful-api'
+import createContentfulApi, { CreateContentfulApiParams } from './create-contentful-api.js'
 import {
   ChainOptions,
   DefaultChainOption,
   ChainOption,
   ModifiersFromOptions,
-} from './utils/client-helpers'
-import { ContentfulClientApi } from './types'
+} from './utils/client-helpers.js'
+import type { ContentfulClientApi } from './types/index.js'
 
 function create<OptionsType extends ChainOptions>(
   { http, getGlobalOptions }: CreateContentfulApiParams,

lib/paged-sync.ts

@@ -1,7 +1,7 @@
 import resolveResponse from 'contentful-resolve-response'
 import { AxiosInstance, createRequestConfig, freezeSys, toPlainObject } from 'contentful-sdk-core'
-import mixinStringifySafe from './mixins/stringify-safe'
-import {
+import mixinStringifySafe from './mixins/stringify-safe.js'
+import type {
   SyncPageQuery,
   SyncResponse,
   SyncPageResponse,
@@ -11,8 +11,8 @@ import {
   SyncQuery,
   LocaleCode,
   EntrySkeletonType,
-} from './types'
-import { ChainOptions, ModifiersFromOptions } from './utils/client-helpers'
+} from './types/index.js'
+import { ChainOptions, ModifiersFromOptions } from './utils/client-helpers.js'
 
 /**
  * Retrieves all the available pages for a sync operation

lib/types/index.ts

@@ -1,15 +1,15 @@
-export * from './asset'
-export * from './asset-key'
-export { AddChainModifier, ChainModifiers, ContentfulClientApi } from './client'
-export * from './collection'
-export * from './content-type'
-export * from './entry'
-export * from './link'
-export * from './locale'
-export * from './metadata'
-export * from './query'
-export * from './resource-link'
-export * from './space'
-export * from './sync'
-export * from './sys'
-export * from './tag'
+export * from './asset.js'
+export * from './asset-key.js'
+export { AddChainModifier, ChainModifiers, ContentfulClientApi } from './client.js'
+export * from './collection.js'
+export * from './content-type.js'
+export * from './entry.js'
+export * from './link.js'
+export * from './locale.js'
+export * from './metadata.js'
+export * from './query/index.js'
+export * from './resource-link.js'
+export * from './space.js'
+export * from './sync.js'
+export * from './sys.js'
+export * from './tag.js'

lib/types/query/index.ts

@@ -3,16 +3,16 @@ export {
   EntrySkeletonType,
   type ConditionalFixedQueries,
   type ConditionalListQueries,
-} from './util'
+} from './util.js'
 
-export * from './equality'
-export * from './existence'
-export * from './location'
-export * from './order'
-export * from './query'
-export * from './range'
-export * from './reference'
-export * from './search'
-export * from './select'
-export * from './set'
-export * from './subset'
+export * from './equality.js'
+export * from './existence.js'
+export * from './location.js'
+export * from './order.js'
+export * from './query.js'
+export * from './range.js'
+export * from './reference.js'
+export * from './search.js'
+export * from './select.js'
+export * from './set.js'
+export * from './subset.js'

lib/utils/resolve-circular.ts

@@ -1,6 +1,7 @@
-import mixinStringifySafe from '../mixins/stringify-safe'
 import resolveResponse from 'contentful-resolve-response'
 
+import mixinStringifySafe from '../mixins/stringify-safe.js'
+
 export default function resolveCircular(data: any, { resolveLinks, removeUnresolved }): any {
   const wrappedData = mixinStringifySafe(data)
   if (resolveLinks) {

lib/utils/validate-params.ts

@@ -1,4 +1,4 @@
-import { ValidationError } from './validation-error'
+import { ValidationError } from './validation-error.js'
 
 function checkLocaleParamIsAll(query) {
   if (query.locale === '*') {

lib/utils/validate-timestamp.ts

@@ -1,4 +1,4 @@
-import { ValidationError } from './validation-error'
+import { ValidationError } from './validation-error.js'
 
 type Options = {
   maximum?: number