integreat 0.7.42 → 0.7.44

package/index.d.ts

@@ -27,6 +27,10 @@ declare namespace integreat {
   export interface Meta {
     queue?: boolean | number
     ident?: Ident
+    project?: string
+    id?: string
+    cid?: string
+    gid?: string
     [key: string]: unknown
   }
 

package/lib/actions/expire.js

@@ -1,37 +1,42 @@
 const action = require('../utils/createAction')
 const createError = require('../utils/createError')
 
-const getExpired = async (payload, ident, dispatch) => {
-  const {
-    service,
-    type,
-    endpoint,
-    msFromNow = 0
-  } = payload
+const getExpired = async (payload, ident, dispatch, gid, cid) => {
+  const { service, type, endpoint, msFromNow = 0 } = payload
 
   const timestamp = Date.now() + msFromNow
   const isodate = new Date(timestamp).toISOString()
-  const payloadGet = { service, type, endpoint, onlyMappedValues: true, timestamp, isodate }
+  const payloadGet = {
+    service,
+    type,
+    endpoint,
+    onlyMappedValues: true,
+    timestamp,
+    isodate,
+  }
 
-  return dispatch(action('GET', payloadGet, { ident }))
+  return dispatch(action('GET', payloadGet, { ident, gid, cid }))
 }
 
-const deleteExpired = async (response, service, ident, dispatch) => {
+const deleteExpired = async (response, service, ident, dispatch, gid, cid) => {
   if (response.status !== 'ok' || !Array.isArray(response.data)) {
-    return createError(`Could not get items from service '${service}'. Reason: ${response.status} ${response.error}`, 'noaction')
+    return createError(
+      `Could not get items from service '${service}'. Reason: ${response.status} ${response.error}`,
+      'noaction'
+    )
   }
   if (response.data.length === 0) {
-    return createError(`No items to expire from service '${service}'`, 'noaction')
+    return createError(
+      `No items to expire from service '${service}'`,
+      'noaction'
+    )
   }
 
-  const data = response.data.map((item) =>
-    ({ id: item.id, type: item.type }))
+  const data = response.data.map((item) => ({ id: item.id, type: item.type }))
 
-  return dispatch(action(
-    'DELETE',
-    { service, data },
-    { queue: true, ident }
-  ))
+  return dispatch(
+    action('DELETE', { service, data }, { queue: true, ident, gid, cid })
+  )
 }
 
 /**
@@ -49,23 +54,27 @@ const deleteExpired = async (response, service, ident, dispatch) => {
  * @param {Object} resources - Dispatch and queue functions
  * @returns {Object} Response object
  */
-async function expire ({ payload, meta = {} }, { dispatch }) {
+async function expire({ payload, meta = {} }, { dispatch }) {
   const { service } = payload
-  const { ident } = meta
+  const { ident, id, cid } = meta
 
   if (!service) {
-    return createError('Can\'t delete expired without a specified service')
+    return createError("Can't delete expired without a specified service")
   }
   if (!payload.endpoint) {
-    return createError(`Can't delete expired from service '${service}' without an endpoint`)
+    return createError(
+      `Can't delete expired from service '${service}' without an endpoint`
+    )
   }
   if (!payload.type) {
-    return createError(`Can't delete expired from service '${service}' without one or more specified types`)
+    return createError(
+      `Can't delete expired from service '${service}' without one or more specified types`
+    )
   }
 
-  const response = await getExpired(payload, ident, dispatch)
+  const response = await getExpired(payload, ident, dispatch, id, cid)
 
-  return deleteExpired(response, service, ident, dispatch)
+  return deleteExpired(response, service, ident, dispatch, id, cid)
 }
 
 module.exports = expire

package/lib/actions/getIdent.js

@@ -6,17 +6,25 @@ const createUnknownServiceError = require('../utils/createUnknownServiceError')
 const preparePropKeys = ({
   id = 'id',
   roles = 'roles',
-  tokens = 'tokens'
+  tokens = 'tokens',
 } = {}) => ({
-  id, roles, tokens
+  id,
+  roles,
+  tokens,
 })
 
 const prepareParams = (ident, keys) =>
-  (ident.id) ? { [keys.id]: ident.id }
-    : (ident.withToken) ? { [keys.tokens]: ident.withToken }
-      : null
+  ident.id
+    ? { [keys.id]: ident.id }
+    : ident.withToken
+    ? { [keys.tokens]: ident.withToken }
+    : null
 
-const wrapOk = (data, ident) => ({ status: 'ok', data, access: { status: 'granted', ident } })
+const wrapOk = (data, ident) => ({
+  status: 'ok',
+  data,
+  access: { status: 'granted', ident },
+})
 
 const prepareResponse = (response, params, propKeys) => {
   const { data } = response
@@ -25,28 +33,34 @@ const prepareResponse = (response, params, propKeys) => {
     const completeIdent = {
       id: getField(data[0], propKeys.id),
       roles: getField(data[0], propKeys.roles),
-      tokens: getField(data[0], propKeys.tokens)
+      tokens: getField(data[0], propKeys.tokens),
     }
     return wrapOk(data[0], completeIdent)
   } else {
-    return createError(`Could not find ident with params ${util.inspect(params)}`, 'notfound')
+    return createError(
+      `Could not find ident with params ${util.inspect(params)}`,
+      'notfound'
+    )
   }
 }
 
 /**
-* Get an ident item from service, based on the meta.ident object on the action.
-* @param {Object} action - Action object
-* @param {Object} resources - Object with getService and identOptions
-* @returns {Object} Response object with ident item as data
+ * Get an ident item from service, based on the meta.ident object on the action.
+ * @param {Object} action - Action object
+ * @param {Object} resources - Object with getService and identOptions
+ * @returns {Object} Response object with ident item as data
  */
-async function getIdent ({ payload, meta }, { getService, identOptions = {} }) {
+async function getIdent({ payload, meta }, { getService, identOptions = {} }) {
   if (!meta.ident) {
     return createError('GET_IDENT: The request has no ident', 'noaction')
   }
 
   const { type } = identOptions
   if (!type) {
-    return createError('GET_IDENT: Integreat is not set up with authentication', 'noaction')
+    return createError(
+      'GET_IDENT: Integreat is not set up with authentication',
+      'noaction'
+    )
   }
 
   const service = getService(type)
@@ -57,13 +71,16 @@ async function getIdent ({ payload, meta }, { getService, identOptions = {} }) {
   const propKeys = preparePropKeys(identOptions.props)
   const params = prepareParams(meta.ident, propKeys)
   if (!params) {
-    return createError('GET_IDENT: The request has no ident with id or withToken', 'noaction')
+    return createError(
+      'GET_IDENT: The request has no ident with id or withToken',
+      'noaction'
+    )
   }
 
   const { response } = await service.send({
     type: 'GET',
     payload: { type, ...params },
-    meta: { ident: { root: true } }
+    meta: { ident: { root: true } },
   })
 
   return prepareResponse(response, payload, propKeys)

package/lib/actions/set.js

@@ -5,8 +5,9 @@ const appendToAction = require('../utils/appendToAction')
 const { mergeDeepWith } = require('ramda')
 
 const mergeDiff = (left, right) =>
-  (is.undefined(right) || (is.emptyArray(right) && is.nonEmptyArray(left)))
-    ? left : right
+  is.undefined(right) || (is.emptyArray(right) && is.nonEmptyArray(left))
+    ? left
+    : right
 
 const merge = (requestData, responseData) => {
   requestData = [].concat(requestData)
@@ -15,16 +16,20 @@ const merge = (requestData, responseData) => {
   }
   responseData = [].concat(responseData)
 
-  return requestData.map(
-    (data, index) => (data) ? mergeDeepWith(mergeDiff, data, responseData[index]) : responseData[index]
+  return requestData.map((data, index) =>
+    data
+      ? mergeDeepWith(mergeDiff, data, responseData[index])
+      : responseData[index]
   )
 }
 
-const mergeRequestAndResponseData = (response, requestData) => (response.status === 'ok')
-  ? { ...response, data: merge(requestData, response.data) }
-  : response
+const mergeRequestAndResponseData = (response, requestData) =>
+  response.status === 'ok'
+    ? { ...response, data: merge(requestData, response.data) }
+    : response
 
-const extractType = (action, data) => action.payload.type || (data && data.type) || undefined
+const extractType = (action, data) =>
+  action.payload.type || (data && data.type) || undefined
 
 const extractId = (data) => (data && data.id) || undefined
 
@@ -34,14 +39,14 @@ const extractId = (data) => (data && data.id) || undefined
  * @param {Object} resources - Object with getService
  * @returns {Object} Response object with any data returned from the service
  */
-async function set (action, { getService, schemas }) {
+async function set(action, { getService }) {
   debug('Action: SET')
 
   const {
     service: serviceId,
     data,
     endpoint,
-    onlyMappedValues = true
+    onlyMappedValues = true,
   } = action.payload
   const type = extractType(action, data)
   const id = extractId(data)
@@ -51,14 +56,11 @@ async function set (action, { getService, schemas }) {
     return createUnknownServiceError(type, serviceId, 'SET')
   }
 
-  const endpointDebug = (endpoint) ? `at endpoint '${endpoint}'` : ''
+  const endpointDebug = endpoint ? `at endpoint '${endpoint}'` : ''
   debug('SET: Send to service %s %s', service.id, endpointDebug)
 
-  const {
-    response,
-    authorizedRequestData,
-    mapResponseWithType
-  } = await service.send(appendToAction(action, { id, type, onlyMappedValues }))
+  const { response, authorizedRequestData, mapResponseWithType } =
+    await service.send(appendToAction(action, { id, type, onlyMappedValues }))
 
   return mapResponseWithType
     ? mergeRequestAndResponseData(response, authorizedRequestData)

package/lib/actions/sync.js

@@ -7,8 +7,8 @@ const createError = require('../utils/createError')
 const createTransformAction = (
   { action: type, ...payload },
   data,
-  { ident, project }
-) => action(type, { ...payload, data }, { ident, project })
+  { ident, project, id: gid, cid }
+) => action(type, { ...payload, data }, { ident, project, gid, cid })
 
 const makeErrorString = (results) =>
   results
@@ -27,13 +27,20 @@ const generateUpdatedAfter = (updatedAfter, afterDelta) => ({
 })
 
 const setUpdatedParams =
-  (dispatch, dontSetUntil, afterDelta, untilDelta, metaKey, ident) =>
+  (
+    dispatch,
+    dontSetUntil,
+    afterDelta,
+    untilDelta,
+    metaKey,
+    { ident, id: gid, cid }
+  ) =>
   async (params) => {
     const { status, data, error } = await dispatch(
       action(
         'GET_META',
         { service: params.service, metaKey, keys: 'lastSyncedAt' },
-        { ident }
+        { ident, gid, cid }
       )
     )
 
@@ -59,7 +66,7 @@ const setUpdatedParams =
 const generateParamsWithUpdatedDates = async (
   params,
   dispatch,
-  ident,
+  meta,
   updatedAfter,
   updatedUntil,
   afterDelta,
@@ -87,7 +94,7 @@ const generateParamsWithUpdatedDates = async (
           afterDelta,
           untilDelta,
           metaKey,
-          ident
+          meta
         )
       )
     )
@@ -107,7 +114,7 @@ const generateFromParams = async (
     untilDelta,
     metaKey,
   },
-  { ident },
+  meta,
   dispatch
 ) => {
   const fromParams = [].concat(from).map(paramsFromStringOrObject)
@@ -115,7 +122,7 @@ const generateFromParams = async (
     return generateParamsWithUpdatedDates(
       fromParams,
       dispatch,
-      ident,
+      meta,
       updatedAfter,
       updatedUntil,
       afterDelta,
@@ -167,10 +174,10 @@ const isWithinUpdateWindow = (updatedAfter, updatedUntil) => (item) =>
   (!updatedUntil || item.attributes.updatedAt <= updatedUntil)
 
 const getFromService =
-  (dispatch, type, noFilter = false, { project, ident }) =>
+  (dispatch, type, noFilter = false, { project, ident, id: gid, cid }) =>
   async ({ action: fromAction = 'GET', ...fromParams }) => {
     const response = await dispatch(
-      action(fromAction, { type, ...fromParams }, { project, ident })
+      action(fromAction, { type, ...fromParams }, { project, ident, gid, cid })
     )
     if (response.status !== 'ok') {
       return createError(
@@ -199,7 +206,7 @@ const createSetMetas = (
   fromParams,
   lastSyncedAt,
   metaKey,
-  ident,
+  { ident, id: gid, cid },
   dispatch,
   getService
 ) =>
@@ -218,24 +225,32 @@ const createSetMetas = (
         action(
           'SET_META',
           { service, metaKey, meta: { lastSyncedAt } },
-          { ident }
+          { ident, gid, cid }
         )
       )
     )
 
-const createSetActions = (toAction, data, toParams, meta, useIndividualSet) =>
+const createSetActions = (
+  toAction,
+  data,
+  toParams,
+  { id: gid, cid, ...meta },
   useIndividualSet
-    ? data.map((item) => action(toAction, { data: item, ...toParams }, meta))
-    : [action(toAction, { data, ...toParams }, meta)]
+) =>
+  useIndividualSet
+    ? data.map((item) =>
+        action(toAction, { data: item, ...toParams }, { ...meta, gid, cid })
+      )
+    : [action(toAction, { data, ...toParams }, { ...meta, gid, cid })]
 
 const createDoneAction = (
   data,
   { action: type = 'SET', ...params },
-  { ident, project }
+  { ident, project, id: gid, cid }
 ) => ({
   type,
   payload: { ...params, data },
-  meta: { ident, project },
+  meta: { ident, project, gid, cid },
 })
 
 const isError = (response) =>
@@ -381,7 +396,7 @@ async function sync({ payload, meta = {} }, { dispatch, getService }) {
     fromParams,
     lastSyncedAt,
     metaKey,
-    meta.ident,
+    meta,
     dispatch,
     getService
   )

package/lib/dispatch.js

@@ -1,3 +1,4 @@
+const { nanoid } = require('nanoid')
 const debug = require('debug')('great')
 const PProgress = require('p-progress')
 const setupGetService = require('./utils/getService')
@@ -22,6 +23,17 @@ const handleAction = (action, resources, actionHandlers) => {
   return PProgress.resolve({ status: 'noaction' })
 }
 
+function setIds(action) {
+  if (!action) {
+    return action
+  }
+  const meta = action.meta || {}
+  const id = meta.id || nanoid()
+  const cid = meta.cid || id
+  const gid = meta.gid || id
+  return { ...action, meta: { ...meta, id, cid, gid } }
+}
+
 /**
  * Setup and return dispatch function. The dispatch function will call the
  * relevant action handler.
@@ -60,7 +72,7 @@ function setupDispatch({
               },
               actionHandlers
             )
-          )(action)
+          )(setIds(action))
         )
       } catch (err) {
         reject(err)

package/lib/integreat.js

@@ -5,7 +5,7 @@ const setupMapping = require('./mapping')
 const setupDispatch = require('./dispatch')
 const builtinActions = require('./actions')
 
-const version = '0.7.42'
+const version = '0.7.44'
 
 /**
  * Return an Integreat instance with a dispatch method.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "integreat",
-  "version": "0.7.42",
+  "version": "0.7.44",
   "description": "Node.js integration layer",
   "author": "Kjell-Morten Bratsberg Thorsen <post@kjellmorten.no> (http://kjellmorten.no/)",
   "license": "ISC",
@@ -46,11 +46,12 @@
   },
   "dependencies": {
     "@sindresorhus/is": "^1.2.0",
-    "debug": "^4.3.4",
+    "debug": "^4.3.7",
     "got": "^9.6.0",
     "later": "^1.2.0",
     "map-any": "^0.2.1",
     "map-transform": "^0.3.12",
+    "nanoid": "^3.3.7",
     "p-limit": "^2.3.0",
     "p-progress": "^0.5.1",
     "ramda": "^0.27.2",
@@ -62,9 +63,9 @@
     "coveralls": "^3.1.1",
     "dotenv": "^10.0.0",
     "integreat-adapter-json": "^0.2.1",
-    "nock": "^13.2.9",
+    "nock": "^13.5.6",
     "nyc": "^15.1.0",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.8",
     "sinon": "^11.1.2"
   }
 }