pubnub/src/core/endpoints/spaces/update_space.js

Publish & Subscribe Real-time Messaging with PubNub

/* @flow */

import {
  SpacesObjectInput,
  SpacesResponse,
  ModulesInject,
} from '../../flow_interfaces';
import operationConstants from '../../constants/operations';
import utils from '../../utils';

function prepareMessagePayload(modules, incomingParams) {
  return incomingParams;
}

export function getOperation(): string {
  return operationConstants.PNUpdateSpaceOperation;
}

export function validateParams(
  { config }: ModulesInject,
  incomingParams: SpacesObjectInput
) {
  let { id, name, custom } = incomingParams;

  if (!id) return 'Missing Space.id';
  if (!name) return 'Missing Space.name';
  if (!config.subscribeKey) return 'Missing Subscribe Key';

  if (custom) {
    if (
      !Object.values(custom).every(
        (value) => typeof value === 'string' ||
                   typeof value === 'number' ||
                   typeof value === 'boolean'
      )
    ) {
      return 'Invalid custom type, only string, number and boolean values are allowed.';
    }
  }
}

export function usePatch() {
  return true;
}

export function getURL(modules: ModulesInject, incomingParams: SpacesObjectInput): string {
  let { config } = modules;
  const { id } = incomingParams;
  return `/v1/objects/${config.subscribeKey}/spaces/${utils.encodeString(id)}`;
}

export function patchURL(modules: ModulesInject, incomingParams: SpacesObjectInput): string {
  const { config } = modules;
  const { id } = incomingParams;
  return `/v1/objects/${config.subscribeKey}/spaces/${utils.encodeString(id)}`;
}

export function getRequestTimeout({ config }: ModulesInject) {
  return config.getTransactionTimeout();
}

export function isAuthSupported() {
  return true;
}

export function getAuthToken(modules: ModulesInject, incomingParams: SpacesObjectInput): string {
  let token =
    modules.tokenManager.getToken('space', incomingParams.id) ||
    modules.tokenManager.getToken('space');

  return token;
}

export function prepareParams(
  modules: ModulesInject,
  incomingParams: SpacesObjectInput
): Object {
  let { include } = incomingParams;
  const params = {};

  // default to include custom fields in response
  if (!include) {
    include = {
      customFields: true
    };
  } else if (include.customFields === undefined) {
    include.customFields = true;
  }

  if (include) {
    let includes = [];

    if (include.customFields) {
      includes.push('custom');
    }

    let includesString = includes.join(',');

    if (includesString.length > 0) {
      params.include = includesString;
    }
  }

  return params;
}

export function patchPayload(
  modules: ModulesInject,
  incomingParams: SpacesObjectInput
): Object {
  return prepareMessagePayload(modules, incomingParams);
}

export function handleResponse(
  modules: ModulesInject,
  spacesResponse: Object
): SpacesResponse {
  return spacesResponse;
}