@takeshape/schema 8.28.0 → 8.33.0

package/es/migration-utils.js

@@ -0,0 +1,186 @@
+/**
+ * This file is a stop-gap for this story: https://app.shortcut.com/takeshape/story/7140/reorganize-schema-migration-ts-into-a-directory
+ */
+import { isAnyServiceConfig } from './types/utils';
+import { pascalCase } from '@takeshape/util';
+import isObject from 'lodash/isObject';
+import isString from 'lodash/isString';
+import isUndefined from 'lodash/isUndefined';
+/**
+ * `graphql:my-key` `my-key`
+ */
+
+export function parseV3ServiceStr(service) {
+  const parts = service.split(':');
+  return {
+    provider: parts.length > 1 ? parts[0] : undefined,
+    id: parts.length > 1 ? parts[1] : parts[0]
+  };
+}
+/**
+ * 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';
+  }
+
+  return 'unknown';
+}

package/es/migration.js

@@ -1,11 +1,13 @@
 import pReduce from 'p-reduce';
 import forEach from 'lodash/forEach';
 import pick from 'lodash/pick';
+import mapValues from 'lodash/mapValues';
+import isObject from 'lodash/isObject';
+import fromPairs from 'lodash/fromPairs';
 import { pascalCase, deepClone, visit } from '@takeshape/util';
 import { arraySchemaKeys, getShapeQueriesAndMutations, multipleRelationshipSchemaKeys, objectSchemaKeys, scalarSchemaKeys, schemaMetadataKeys } from './schema-util';
-import { updateServiceConfigV3ToV3_1 } from './services';
-import { isServiceAuthentication, isProjectSchemaV1, isProjectSchemaV3, isLatestProjectSchema, isProjectSchemaV3_1, isProjectSchemaV3_2, isProjectSchemaV3_3, isProjectSchemaV3_4, isProjectSchemaV3_5, isProjectSchemaV3_5_1, isProjectSchemaV3_6, isProjectSchemaV3_7, isProjectSchemaV3_8, isProjectSchemaV3_9 } from './types/utils';
-import mapValues from 'lodash/mapValues';
+import { updateServiceConfigV3ToV3_1 } from './migration-utils';
+import { isProjectSchemaV1, isProjectSchemaV3, isLatestProjectSchema, isProjectSchemaV3_1, isProjectSchemaV3_2, isProjectSchemaV3_3, isProjectSchemaV3_4, isProjectSchemaV3_5, isProjectSchemaV3_5_1, isProjectSchemaV3_6, isProjectSchemaV3_7, isProjectSchemaV3_8, isProjectSchemaV3_9, isProjectSchemaV3_10 } from './types/utils';
 export const listTypePrefix = 'PaginatedList';
 const annotationMap = {
   l10n: '@l10n',
@@ -284,7 +286,7 @@ export async function migrateToV3_1(context, projectSchema) {
       }, serviceKey);
       const authentication = updatedServiceConfig === null || updatedServiceConfig === void 0 ? void 0 : updatedServiceConfig.authentication;
       serviceMap[serviceKey] = { ...updatedServiceConfig,
-        authentication: isServiceAuthentication(authentication) ? encryptFn(authentication) : authentication
+        authentication: authentication && isObject(authentication) ? encryptFn(authentication) : authentication
       };
       return serviceMap;
     }, {});
@@ -497,6 +499,101 @@ export function migrateToV3_10(projectSchema) {
     schemaVersion: '3.10.0'
   };
 }
+export function migrateToV3_11_0({
+  decryptFn,
+  encryptFn
+}, projectSchema) {
+  const migratedServices = [];
+
+  for (const [serviceKey, serviceConfig] of Object.entries(projectSchema.services ?? {})) {
+    const {
+      authenticationType,
+      authentication
+    } = serviceConfig; // Migrate authentication, ensuring now required properties
+
+    if (authentication && authenticationType !== 'unknown' && authenticationType !== 'none') {
+      const decrypted = decryptFn(authentication);
+
+      if (!decrypted) {
+        throw new Error(`Service "${serviceKey}" authentication could not be decrypted. Please contact support.`);
+      }
+
+      let migrated;
+
+      if (authenticationType === 'searchParams') {
+        migrated = {
+          params: decrypted,
+          type: authenticationType
+        };
+      }
+
+      if (authenticationType === 'basic') {
+        migrated = {
+          username: '',
+          password: '',
+          ...decrypted,
+          type: authenticationType
+        };
+      }
+
+      if (authenticationType === 'bearer') {
+        migrated = {
+          token: '',
+          ...decrypted,
+          type: authenticationType
+        };
+      }
+
+      if (authenticationType === 'oauth2Bearer') {
+        migrated = {
+          token: '',
+          ...decrypted,
+          type: authenticationType
+        };
+      }
+
+      if (authenticationType === 'oauth2') {
+        migrated = {
+          grantType: 'clientCredentials',
+          clientId: '',
+          ...decrypted,
+          type: authenticationType
+        };
+      }
+
+      if (authenticationType === 'aws') {
+        migrated = {
+          awsAccessKeyId: '',
+          awsSecretAccessKey: '',
+          ...decrypted,
+          type: authenticationType
+        };
+      }
+
+      if (authenticationType === 'custom') {
+        migrated = { ...decrypted,
+          type: authenticationType
+        };
+      }
+
+      if (migrated) {
+        const migratedServiceConfig = { ...serviceConfig,
+          authentication: encryptFn(migrated)
+        };
+        migratedServices.push([serviceKey, migratedServiceConfig]);
+      } else {
+        migratedServices.push([serviceKey, serviceConfig]);
+      }
+    } else {
+      migratedServices.push([serviceKey, serviceConfig]);
+    }
+  }
+
+  return { ...projectSchema,
+    services: fromPairs(migratedServices),
+    schemaVersion: '3.11.0'
+  };
+}
 export async function migrateToLatestProjectSchema(context, projectSchema) {
   if (projectSchema.schemaVersion === '4.0.0') {
     throw new Error('You are using an unreleased schema version. Migration is not possible');
@@ -550,6 +647,10 @@ export async function migrateToLatestProjectSchema(context, projectSchema) {
     projectSchema = migrateToV3_10(projectSchema);
   }
 
+  if (isProjectSchemaV3_10(projectSchema)) {
+    projectSchema = migrateToV3_11_0(context, projectSchema);
+  }
+
   return projectSchema;
 }
 export function normalizeSchemaVersion(version) {

package/es/mocks.js

@@ -27,6 +27,7 @@ export function createMockServiceConfig(serviceKey, serviceConfig) {
     namespace: pascalCase(serviceKey),
     authenticationType: 'bearer',
     authentication: {
+      type: 'bearer',
       token: 'abc123'
     },
     options: {

package/es/project-schema/index.js

@@ -1,6 +1,7 @@
 // This file is generated by "pnpm json2ts"
 export * from './latest';
 export * from './v4.0.0';
+export * from './v3.11.0';
 export * from './v3.10.0';
 export * from './v3.9.0';
 export * from './v3.8.0';

package/es/project-schema/v3.11.0.js

@@ -0,0 +1 @@
+export {};

package/es/schemas/index.js

@@ -1,8 +1,9 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.10.0';
+export const CURRENT_SCHEMA_VERSION = '3.11.0';
 export { default as anyProjectSchema } from './project-schema.json';
-export { default as latestSchemaJson } from './project-schema/v3.10.0.json';
+export { default as latestSchemaJson } from './project-schema/v3.11.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
+import projectSchemaV3_11_0 from './project-schema/v3.11.0.json';
 import projectSchemaV3_10_0 from './project-schema/v3.10.0.json';
 import projectSchemaV3_9_0 from './project-schema/v3.9.0.json';
 import metaSchemaV3_9_0 from './project-schema/meta-schema-v3.9.0.json';
@@ -28,4 +29,4 @@ import projectSchemaV3_0_0 from './project-schema/v3.0.0.json';
 import metaSchemaV3_0_0 from './project-schema/meta-schema-v3.0.0.json';
 import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
-export const allProjectSchemas = [projectSchemaV4_0_0, projectSchemaV3_10_0, projectSchemaV3_9_0, metaSchemaV3_9_0, projectSchemaV3_8_0, metaSchemaV3_8_0, projectSchemaV3_7_0, metaSchemaV3_7_0, projectSchemaV3_6_0, metaSchemaV3_6_0, projectSchemaV3_5_1, metaSchemaV3_5_1, projectSchemaV3_5_0, metaSchemaV3_5_0, projectSchemaV3_4_0, metaSchemaV3_4_0, projectSchemaV3_3_0, metaSchemaV3_3_0, projectSchemaV3_2_0, metaSchemaV3_2_0, projectSchemaV3_1_0, metaSchemaV3_1_0, projectSchemaV3_0_0, metaSchemaV3_0_0, projectSchemaV1_0_0, metaSchemaV1_0_0];
+export const allProjectSchemas = [projectSchemaV4_0_0, projectSchemaV3_11_0, projectSchemaV3_10_0, projectSchemaV3_9_0, metaSchemaV3_9_0, projectSchemaV3_8_0, metaSchemaV3_8_0, projectSchemaV3_7_0, metaSchemaV3_7_0, projectSchemaV3_6_0, metaSchemaV3_6_0, projectSchemaV3_5_1, metaSchemaV3_5_1, projectSchemaV3_5_0, metaSchemaV3_5_0, projectSchemaV3_4_0, metaSchemaV3_4_0, projectSchemaV3_3_0, metaSchemaV3_3_0, projectSchemaV3_2_0, metaSchemaV3_2_0, projectSchemaV3_1_0, metaSchemaV3_1_0, projectSchemaV3_0_0, metaSchemaV3_0_0, projectSchemaV1_0_0, metaSchemaV1_0_0];

package/es/schemas/index.ts

@@ -1,8 +1,9 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.10.0';
+export const CURRENT_SCHEMA_VERSION = '3.11.0';
 export {default as anyProjectSchema} from './project-schema.json';
-export {default as latestSchemaJson} from './project-schema/v3.10.0.json';
+export {default as latestSchemaJson} from './project-schema/v3.11.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
+import projectSchemaV3_11_0 from './project-schema/v3.11.0.json';
 import projectSchemaV3_10_0 from './project-schema/v3.10.0.json';
 import projectSchemaV3_9_0 from './project-schema/v3.9.0.json';
 import metaSchemaV3_9_0 from './project-schema/meta-schema-v3.9.0.json';
@@ -30,6 +31,7 @@ import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
 export const allProjectSchemas = [
   projectSchemaV4_0_0,
+  projectSchemaV3_11_0,
   projectSchemaV3_10_0,
   projectSchemaV3_9_0,
   metaSchemaV3_9_0,