@takeshape/schema 8.32.0 → 8.33.0

package/es/services.js

@@ -1,33 +1,30 @@
-import { isEncryptedServiceConfig, isAnyServiceConfig } from './types/utils';
-import { pascalCase, deepClone, mergeWithArrayMerge } from '@takeshape/util';
-import projectMetaSchema from './schemas/project-schema/v3.1.0.json';
-import { createSchemaValidator } from '@takeshape/json-schema';
-import isObject from 'lodash/isObject';
+import { mergeWithArrayMerge } from '@takeshape/util';
+import { createAjv } from '@takeshape/json-schema';
+import { SchemaValidationError } from '@takeshape/errors';
 import isNull from 'lodash/isNull';
-import isString from 'lodash/isString';
-import isUndefined from 'lodash/isUndefined';
+import { isEncryptedServiceConfig, isServiceAuthentication } from './types/utils';
 import { getServiceInfo, SERVICE_OBJECT_PATTERN_NAME } from './schema-util';
-
+import { latestSchemaJson } from './schemas';
+import { formatError } from './validate';
 /**
- * `graphql:my-key` `my-key`
+ * Decrypt an encrypted authentication JSON string
+ * Throws an error if decryption fails
  */
-export function parseV3ServiceStr(service) {
-  const parts = service.split(':');
-  return {
-    provider: parts.length > 1 ? parts[0] : undefined,
-    id: parts.length > 1 ? parts[1] : parts[0]
-  };
-}
+// eslint-disable-next-line @typescript-eslint/ban-types
+
 /**
  * Given a `StoredServiceConfig` returns a usable `ServiceConfig` with the
  * authentication object decrypted.
  */
-
 export function decryptServiceConfig(decryptFn, storedServiceConfig) {
   let authentication;
 
   if (isEncryptedServiceConfig(storedServiceConfig)) {
-    authentication = decryptFn(storedServiceConfig.authentication);
+    const decrypted = decryptFn(storedServiceConfig.authentication);
+
+    if (isServiceAuthentication(decrypted)) {
+      authentication = decrypted;
+    }
   }
 
   return { ...storedServiceConfig,
@@ -44,95 +41,70 @@ export async function decryptServiceMap(decryptFn, storedServiceMap) {
     return result.set(serviceKey, decryptServiceConfig(decryptFn, serviceConfig));
   }, new Map());
 }
-/**
- * Provides a `ServiceConfig` validator based on the JSON-schema.
- */
 
 function createServiceConfigValidator() {
+  const validator = createAjv();
   const {
-    serviceConfig: schema,
+    serviceConfig,
     ...definitions
-  } = projectMetaSchema.definitions;
-  const validationSchema = {
-    $id: '#serviceConfig',
+  } = latestSchemaJson.definitions;
+  return validator.compile({
+    $id: 'ServiceConfig',
     definitions,
-    ...schema
-  };
-  return createSchemaValidator(validationSchema);
+    ...serviceConfig
+  });
 }
+
+const serviceConfigValidator = createServiceConfigValidator();
 /**
- * Provides a `ServiceAuthentication` validator. Due to a behavior of `oneOf` and
- * the `removeAdditional` setting, where valid properties are being stripped,
- * this is validated separate from the overall config. May have something to do with
- * JSON Schema's lack of handling for discriminated unions?
+ * Validates a `ServiceConfig` validator based on the JSON-schema.
  */
 
+export function validateServiceConfig(maybeServiceConfig) {
+  var _serviceConfigValidat;
 
-function createServiceAuthenticationValidator() {
-  const {
-    serviceAuthentication: schema,
-    ...definitions
-  } = projectMetaSchema.definitions;
-  const validationSchema = {
-    $id: '#serviceAuthentication',
-    definitions,
-    ...schema
-  };
-  return createSchemaValidator(validationSchema, [], {
-    removeAdditional: false
-  });
-}
+  if (serviceConfigValidator(maybeServiceConfig)) {
+    return maybeServiceConfig;
+  }
 
-const serviceConfigValidator = createServiceConfigValidator();
-const serviceAuthenticationValidator = createServiceAuthenticationValidator();
+  throw new SchemaValidationError('ServiceConfig was invalid', (_serviceConfigValidat = serviceConfigValidator.errors) === null || _serviceConfigValidat === void 0 ? void 0 : _serviceConfigValidat.map(formatError));
+}
 /**
  * Prepare a `ServiceConfig` object update, validating the overall structure
  * and encrypting the `ServiceAuthentication` object.
  */
 // eslint-disable-next-line max-params
 
-export function prepareServiceUpdate(encryptFn, decryptFn, projectSchema, partialServiceConfig, serviceKey) {
-  var _projectSchema$servic;
-
-  const storedServiceConfig = (_projectSchema$servic = projectSchema.services) === null || _projectSchema$servic === void 0 ? void 0 : _projectSchema$servic[serviceKey];
-  let newServiceConfig = partialServiceConfig;
+export function prepareServiceUpdate(encryptFn, decryptFn, projectSchema, serviceConfigUpdate, serviceKey) {
+  const storedServiceConfig = getStoredServiceConfig(projectSchema, serviceKey);
+  let newServiceConfig = serviceConfigUpdate;
 
   if (storedServiceConfig) {
     const existingServiceConfig = decryptServiceConfig(decryptFn, storedServiceConfig);
-    newServiceConfig = mergeWithArrayMerge(existingServiceConfig, partialServiceConfig);
-  }
-
-  if (isNull(newServiceConfig.authentication)) {
-    delete newServiceConfig.authentication;
-  }
-
-  let authentication;
-
-  if (newServiceConfig.authentication) {
-    // Copy authentication, to ensure validation doesn't remove any properties
-    authentication = deepClone(newServiceConfig.authentication);
-    const {
-      errorsText: authenticationErrors
-    } = serviceAuthenticationValidator(authentication);
-
-    if (authenticationErrors) {
-      throw new Error(authenticationErrors);
-    }
+    newServiceConfig = mergeWithArrayMerge(existingServiceConfig, serviceConfigUpdate);
   }
 
   const {
-    errorsText: configErrors
-  } = serviceConfigValidator(newServiceConfig);
+    authentication,
+    authenticationType
+  } = newServiceConfig;
 
-  if (configErrors) {
-    throw new Error(configErrors);
+  if (authenticationType === 'none' || isNull(authentication)) {
+    delete newServiceConfig.authentication;
+  } else if (authentication !== undefined) {
+    // Add the discriminator to the authentication object, set authenticationType
+    // to ensure the update is correct for the auth type.
+    newServiceConfig.authentication = { ...authentication,
+      type: authenticationType
+    };
   }
 
+  validateServiceConfig(newServiceConfig);
   let serviceConfig;
 
-  if (authentication) {
+  if (newServiceConfig.authentication) {
     serviceConfig = { ...newServiceConfig,
-      authentication: encryptFn(authentication)
+      authentication: encryptFn(newServiceConfig.authentication)
     };
   } else {
     serviceConfig = newServiceConfig;
@@ -145,191 +117,21 @@ export function prepareServiceUpdate(encryptFn, decryptFn, projectSchema, partia
  */
 
 export function getStoredServiceConfig(projectSchema, serviceKey) {
-  var _projectSchema$servic2;
-
-  return (_projectSchema$servic2 = projectSchema.services) === null || _projectSchema$servic2 === void 0 ? void 0 : _projectSchema$servic2[serviceKey];
-}
-/**
- * Migration-related Functions
- *
- * All the following code is used in the migration process. At some point
- * migraton code should live outside the standard runtime code.
- */
-
-/**
- * Ensures a consistent service config, inluding updating the service
- * authentication object.
- */
-// eslint-disable-next-line complexity
-
-export function updateServiceConfigV3ToV3_1(serviceConfig, serviceKey) {
-  if (isAnyServiceConfig(serviceConfig)) {
-    if (isString(serviceConfig.authentication) || isUndefined(serviceConfig.authentication)) {
-      return serviceConfig;
-    }
-
-    return serviceConfig;
-  }
-
-  const {
-    auth
-  } = serviceConfig;
-  const serviceParams = serviceConfig.params || {};
-  let {
-    provider: serviceKeyProvider,
-    id: serviceKeyId
-  } = parseV3ServiceStr(serviceKey);
-  const authType = serviceParams.authType || undefined;
-  const title = serviceParams.name || serviceKeyId;
-
-  if (serviceKeyId === 'vercel') {
-    serviceKeyProvider = 'vercel';
-  } else if (serviceKeyId === 'netlify') {
-    serviceKeyProvider = 'netlify';
-  } // Example schemas had this in params, which are untyped, so adding here just in case
-
-
-  if (serviceParams.type === 'rest') {
-    serviceKeyProvider = 'rest';
-  } else if (serviceParams.type === 'graphql' && serviceKeyProvider !== 'shopify') {
-    serviceKeyProvider = 'graphql';
-  }
-
-  let provider;
-  let authenticationType;
-  let serviceType;
-  let namespace;
-
-  if (serviceKeyProvider === 'shopify') {
-    provider = 'shopify';
-    authenticationType = 'oauth2Bearer';
-    serviceType = 'graphql';
-    namespace = serviceParams.namespace ?? 'Shopify';
-  } else if (serviceKeyProvider === 'takeshape') {
-    provider = 'takeshape';
-    authenticationType = 'none';
-    serviceType = 'takeshape';
-    namespace = serviceParams.namespace ?? 'TakeShape';
-  } else if (serviceKeyProvider === 'bigcommerce') {
-    provider = 'bigcommerce';
-    authenticationType = 'bearer';
-    serviceType = 'graphql';
-    namespace = serviceParams.namespace ?? 'BigCommerce';
-  } else if (serviceKeyProvider === 'rest') {
-    provider = 'generic';
-    authenticationType = mapAuthType(authType, auth);
-    serviceType = 'rest';
-    namespace = serviceParams.namespace ?? pascalCase(title);
-  } else if (serviceKeyProvider === 'graphql') {
-    provider = 'generic';
-    authenticationType = mapAuthType(authType, auth);
-    serviceType = 'graphql';
-    namespace = serviceParams.namespace ?? pascalCase(title);
-  } else if (serviceKeyProvider === 'vercel') {
-    provider = 'vercel';
-    authenticationType = 'oauth2Bearer';
-    serviceType = 'deployment';
-  } else if (serviceKeyProvider === 'netlify') {
-    provider = 'netlify';
-    authenticationType = 'oauth2Bearer';
-    serviceType = 'deployment';
-  } else {
-    provider = 'generic';
-    authenticationType = mapAuthType(authType, auth);
-    serviceType = 'unknown';
-    namespace = serviceParams.namespace ?? pascalCase(title);
-  }
-
-  const updatedServiceConfig = {
-    title,
-    id: serviceKey,
-    provider,
-    namespace,
-    serviceType,
-    authenticationType,
-    options: { ...serviceParams
-    }
-  };
-
-  if (serviceConfig.auth && isObject(serviceConfig.auth)) {
-    const authentication = updateServiceAuthentication(updatedServiceConfig.authenticationType, serviceConfig.auth, serviceParams);
-    return { ...updatedServiceConfig,
-      authentication
-    };
-  }
-
-  return updatedServiceConfig;
-}
-/**
- * V1/V3 unencrypted `auth` -> V3.1 `authentication
- */
-
-function updateServiceAuthentication(authenticationType, legacyAuth, legacyParams) {
-  if (authenticationType === 'oauth2Bearer') {
-    return {
-      token: legacyAuth.accessToken,
-      scope: legacyAuth.scope,
-      header: legacyParams.authHeader
-    };
-  }
-
-  if (authenticationType === 'searchParams' && legacyParams.authProp) {
-    return [{
-      name: legacyParams.authProp,
-      value: legacyAuth.accessToken
-    }];
-  }
-
-  if (authenticationType === 'basic') {
-    const [username, password] = Buffer.from(legacyAuth.accessToken, 'base64').toString('utf-8').split(':');
-    return {
-      username,
-      password
-    };
-  }
-
-  if (authenticationType === 'bearer') {
-    return {
-      token: legacyAuth.accessToken,
-      header: legacyParams.authHeader
-    };
-  }
-}
-
-function mapAuthType(authType, auth) {
-  if (authType === 'none') {
-    return 'none';
-  }
-
-  if (authType === 'searchParams') {
-    return 'searchParams';
-  }
-
-  if (authType === 'bearer') {
-    return 'bearer';
-  }
-
-  if (authType === 'bearer') {
-    return 'basic';
-  }
-
-  if (!auth) {
-    return 'none';
-  }
-
-  if (auth) {
-    return 'bearer';
-  }
+  var _projectSchema$servic;
 
-  return 'unknown';
+  return (_projectSchema$servic = projectSchema.services) === null || _projectSchema$servic === void 0 ? void 0 : _projectSchema$servic[serviceKey];
 }
-
 export function getServiceNamespace(serviceConfig) {
   var _serviceConfig$params;
 
   if ('namespace' in serviceConfig && serviceConfig.namespace) {
     return serviceConfig.namespace;
   }
+  /**
+   * TODO This is only necessary if this fn gets called on a schema before migration.
+   * Figure that out and remove if possible.
+   **/
+
 
   if ('params' in serviceConfig && (_serviceConfig$params = serviceConfig.params) !== null && _serviceConfig$params !== void 0 && _serviceConfig$params.namespace) {
     return serviceConfig.params.namespace;

package/es/types/types.js

@@ -13,6 +13,15 @@
  * @deprecated
  */
 
+/**
+ * Support null sentinels for authentication
+ */
+
+/**
+ * A type suitable for service object updates, mostly concerns authentication
+ * requirements.
+ */
+
 /**
  * Types of refs
  */

package/es/types/utils.js

@@ -68,6 +68,7 @@ export const isProjectSchemaV3_7 = createVersionPredicate('3.7.0');
 export const isProjectSchemaV3_8 = createVersionPredicate('3.8.0');
 export const isProjectSchemaV3_9 = createVersionPredicate('3.9.0');
 export const isProjectSchemaV3_10 = createVersionPredicate('3.10.0');
+export const isProjectSchemaV3_11 = createVersionPredicate('3.11.0');
 export const isLatestProjectSchema = createVersionPredicate(CURRENT_SCHEMA_VERSION);
 export function isV3XSchema(maybeSchema) {
   if (!isObject(maybeSchema) || !isString(maybeSchema.projectId) || !isString(maybeSchema.schemaVersion)) {
@@ -87,7 +88,7 @@ export function isAnyProjectSchema(value) {
   }
 
   const maybeSchema = value;
-  return isObject(value) && isString(maybeSchema.projectId) && (isProjectSchemaV1(maybeSchema) || isProjectSchemaV3(maybeSchema) || isProjectSchemaV3_1(maybeSchema) || isProjectSchemaV3_2(maybeSchema) || isProjectSchemaV3_3(maybeSchema) || isProjectSchemaV3_4(maybeSchema) || isProjectSchemaV3_5(maybeSchema) || isProjectSchemaV3_5_1(maybeSchema) || isProjectSchemaV3_6(maybeSchema) || isProjectSchemaV3_7(maybeSchema) || isProjectSchemaV3_8(maybeSchema) || isProjectSchemaV3_9(maybeSchema) || isProjectSchemaV3_10(maybeSchema));
+  return isObject(value) && isString(maybeSchema.projectId) && (isProjectSchemaV1(maybeSchema) || isProjectSchemaV3(maybeSchema) || isProjectSchemaV3_1(maybeSchema) || isProjectSchemaV3_2(maybeSchema) || isProjectSchemaV3_3(maybeSchema) || isProjectSchemaV3_4(maybeSchema) || isProjectSchemaV3_5(maybeSchema) || isProjectSchemaV3_5_1(maybeSchema) || isProjectSchemaV3_6(maybeSchema) || isProjectSchemaV3_7(maybeSchema) || isProjectSchemaV3_8(maybeSchema) || isProjectSchemaV3_9(maybeSchema) || isProjectSchemaV3_10(maybeSchema) || isProjectSchemaV3_11(maybeSchema));
 }
 export function isProjectSchemaWithServices(schema) {
   return typeof schema.dataKey !== 'undefined' && typeof schema.services !== 'undefined';
@@ -239,27 +240,33 @@ export function isEncryptedServiceConfig(maybeConfig) {
   return isAnyServiceConfig(maybeConfig) && isString(maybeConfig.authentication);
 }
 export function isServiceConfigWithOAuth2Authentication(maybeServiceConfig) {
-  return isAnyServiceConfig(maybeServiceConfig) && maybeServiceConfig.authenticationType === 'oauth2' && isOAuth2Authentication(maybeServiceConfig.authentication);
+  return isAnyServiceConfig(maybeServiceConfig) && isServiceAuthentication(maybeServiceConfig.authentication) && isOAuth2Authentication(maybeServiceConfig.authentication);
 }
 export function isServiceConfigWithCustomAuthentication(maybeServiceConfig) {
-  return isAnyServiceConfig(maybeServiceConfig) && maybeServiceConfig.authenticationType === 'custom' && isServiceAuthentication(maybeServiceConfig.authentication);
+  return isAnyServiceConfig(maybeServiceConfig) && isServiceAuthentication(maybeServiceConfig.authentication) && isCustomAuthentication(maybeServiceConfig.authentication);
 }
 /** Authentication Utils **/
 
 export function isServiceAuthentication(maybeAuthentication) {
-  return maybeAuthentication && isObject(maybeAuthentication);
+  return maybeAuthentication === null || maybeAuthentication === void 0 ? void 0 : maybeAuthentication.type;
 }
-export function isBearerAuthentication(maybeAuthentication) {
-  return isServiceAuthentication(maybeAuthentication) && isString(maybeAuthentication.token);
+export function isBearerAuthentication(authentication) {
+  return (authentication === null || authentication === void 0 ? void 0 : authentication.type) === 'bearer';
 }
-export function isBasicAuthentication(maybeAuthentication) {
-  return isServiceAuthentication(maybeAuthentication) && (isString(maybeAuthentication.username) || isString(maybeAuthentication.password));
+export function isBasicAuthentication(authentication) {
+  return (authentication === null || authentication === void 0 ? void 0 : authentication.type) === 'basic';
 }
-export function isSearchParamsAuthentication(maybeAuthentication) {
-  return isArray(maybeAuthentication) && maybeAuthentication.every(value => isObject(value) && Object.entries(value).every(([k, v]) => (k === 'name' || k === 'value') && isString(v)));
+export function isSearchParamsAuthentication(authentication) {
+  return (authentication === null || authentication === void 0 ? void 0 : authentication.type) === 'searchParams';
 }
-export function isOAuth2Authentication(maybeAuthentication) {
-  return isServiceAuthentication(maybeAuthentication) && isString(maybeAuthentication.clientId);
+export function isOAuth2Authentication(authentication) {
+  return (authentication === null || authentication === void 0 ? void 0 : authentication.type) === 'oauth2';
+}
+export function isOAuth2BearerAuthentication(authentication) {
+  return (authentication === null || authentication === void 0 ? void 0 : authentication.type) === 'oauth2Bearer';
+}
+export function isCustomAuthentication(authentication) {
+  return (authentication === null || authentication === void 0 ? void 0 : authentication.type) === 'custom';
 }
 /** Miscellaneous Utils **/
 

package/examples/latest/blog-schema.json

@@ -373,5 +373,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/brewery-schema.json

@@ -378,5 +378,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/complex-project-schema.json

@@ -3892,5 +3892,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/fabric-ecommerce.json

@@ -119,7 +119,7 @@
       "provider": "shopify",
       "serviceType": "graphql",
       "authenticationType": "oauth2Bearer",
-      "authentication": "secret",
+      "authentication": "abc",
       "options": {
         "shop": "michaels-store-takeshape",
         "endpoint": "https://michaels-store-takeshape.myshopify.com/admin/api/2020-07/graphql.json"
@@ -10516,5 +10516,5 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0"
 }

package/examples/latest/frank-and-fred-schema.json

@@ -19833,5 +19833,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/massive-schema.json

@@ -7021,5 +7021,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/mill-components-schema.json

@@ -1787,5 +1787,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/pet-oneof-array.json

@@ -404,5 +404,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/post-schema.json

@@ -220,5 +220,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/pruned-shopify-product-schema.json

@@ -22,7 +22,7 @@
         "shop": "andrews-takeshape-store",
         "endpoint": "https://andrews-takeshape-store.myshopify.com/admin/api/2020-07/graphql.json"
       },
-      "authentication": "secret"
+      "authentication": "abc"
     }
   },
   "dataKey": "secret",
@@ -9760,5 +9760,5 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0"
 }

package/examples/latest/real-world-schema.json

@@ -990,5 +990,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/recursive-repeater-schema.json

@@ -138,5 +138,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/recursive-schema.json

@@ -145,5 +145,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/rick-and-morty-ast.json

@@ -2673,5 +2673,5 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0"
 }

package/examples/latest/rick-and-morty-graphql.json

@@ -2198,5 +2198,5 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0"
 }

package/examples/latest/rick-and-morty-rest.json

@@ -96,5 +96,5 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0"
 }

package/examples/latest/schema-with-repeater-draftjs.json

@@ -377,5 +377,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/shape-books-v3_2_0.json

@@ -1077,5 +1077,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/shape-books.json

@@ -1037,5 +1037,6 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0",
+  "services": {}
 }

package/examples/latest/shopify-lookbook.json

@@ -1176,5 +1176,5 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0"
 }

package/examples/latest/shopify-store-with-widget.json

@@ -707,7 +707,7 @@
       "namespace": "Shopify",
       "serviceType": "graphql",
       "authenticationType": "oauth2Bearer",
-      "authentication": "secret",
+      "authentication": "abc",
       "options": {
         "type": "graphql",
         "namespace": "Shopify",
@@ -12534,5 +12534,5 @@
       }
     }
   },
-  "schemaVersion": "3.10.0"
+  "schemaVersion": "3.11.0"
 }