@takeshape/schema 7.194.0

package/lib/services.d.ts

@@ -0,0 +1,71 @@
+import type { ServiceMap, ServiceKey, ProjectSchemaV3X } from './types';
+import type { ProjectSchema, StoredServiceMap, StoredServiceConfig, ServiceConfig, EncryptedGenericServiceConfigV3_0_0, ServiceAuthentication, StoredServiceConfigV3_1_0, ServiceConfigV3_1_0 } from './project-schema';
+import type { Maybe } from '@takeshape/util';
+import { Overwrite } from '@takeshape/util';
+import { ServiceInfo, PatternGenerator } from './types';
+import { SERVICE_OBJECT_PATTERN_NAME } from './schema-util';
+import { Shape } from './project-schema';
+/**
+ * Decrypt an encrypted authentication JSON string
+ * Throws an error if decryption fails
+ */
+export declare type DecryptFn = (authentication: string) => ServiceAuthentication;
+/**
+ * Decrypt an encrypted authentication JSON string
+ * Returns undefined if decryption fails
+ */
+export declare type SafeDecryptFn = (authentication: string) => ServiceAuthentication | undefined;
+export declare type EncryptFn = (authentication: ServiceAuthentication) => string;
+/**
+ * `graphql:my-key` `my-key`
+ */
+export declare function parseV3ServiceStr(service: string): {
+    provider?: string;
+    id: string;
+};
+/**
+ * Given a `StoredServiceConfig` returns a usable `ServiceConfig` with the
+ * authentication object decrypted.
+ */
+export declare function decryptServiceConfig(decryptFn: DecryptFn, storedServiceConfig: StoredServiceConfig): ServiceConfig;
+/**
+ * Given a `StoredServiceMap` returns a usable `ServiceMap` with all the
+ * authentication objects decrypted.
+ */
+export declare function decryptServiceMap(decryptFn: DecryptFn, storedServiceMap: StoredServiceMap): Promise<ServiceMap>;
+/**
+ * Prepare a `ServiceConfig` object update, validating the overall structure
+ * and encrypting the `ServiceAuthentication` object.
+ */
+export declare function prepareServiceUpdate(encryptFn: EncryptFn, decryptFn: DecryptFn, projectSchema: ProjectSchema, partialServiceConfig: Partial<ServiceConfig>, serviceKey: string): StoredServiceConfig;
+/**
+ * Get a service config from a project schema.
+ */
+export declare function getStoredServiceConfig(projectSchema: ProjectSchema, serviceKey: ServiceKey): Maybe<StoredServiceConfig>;
+/**
+ * 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.
+ */
+export declare function updateServiceConfigV3ToV3_1(serviceConfig: Record<string, unknown>, serviceKey: ServiceKey): StoredServiceConfigV3_1_0 | ServiceConfigV3_1_0;
+export declare function getServiceNamespace(serviceConfig: StoredServiceConfig | EncryptedGenericServiceConfigV3_0_0): string | undefined;
+/**
+ * Get a `Map` keyed with all the service namespaces.
+ *
+ * @param context A partial project schema
+ *
+ * @returns A `Map` with namespaces as keys, and service keys as values.
+ */
+export declare function getServiceNamespaces(context: Pick<ProjectSchemaV3X, 'services'>): Map<string, string>;
+export declare type ServiceInfoWithServiceObject = Overwrite<ServiceInfo, {
+    generators: {
+        [SERVICE_OBJECT_PATTERN_NAME]: PatternGenerator;
+    };
+}>;
+export declare function getServiceObjectFields(projectSchema: ProjectSchema, shape: Shape, provider: string): ServiceInfoWithServiceObject[];
+//# sourceMappingURL=services.d.ts.map

package/lib/services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../src/services.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAE,UAAU,EAA4B,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAEhG,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,mCAAmC,EACnC,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EAEpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAwB,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAEjE,OAAO,EAA+C,WAAW,EAAE,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAOpG,OAAO,EAAiB,2BAA2B,EAAC,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAC,KAAK,EAAC,MAAM,kBAAkB,CAAC;AAEvC;;;GAGG;AACH,oBAAY,SAAS,GAAG,CAAC,cAAc,EAAE,MAAM,KAAK,qBAAqB,CAAC;AAC1E;;;GAGG;AACH,oBAAY,aAAa,GAAG,CAAC,cAAc,EAAE,MAAM,KAAK,qBAAqB,GAAG,SAAS,CAAC;AAC1F,oBAAY,SAAS,GAAG,CAAC,cAAc,EAAE,qBAAqB,KAAK,MAAM,CAAC;AAE1E;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,CAGlF;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,SAAS,EAAE,mBAAmB,EAAE,mBAAmB,GAAG,aAAa,CAWlH;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,CAIrH;AAsCD;;;GAGG;AAEH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,oBAAoB,EAAE,OAAO,CAAC,aAAa,CAAC,EAC5C,UAAU,EAAE,MAAM,GACjB,mBAAmB,CA6CrB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,aAAa,EAC5B,UAAU,EAAE,UAAU,GACrB,KAAK,CAAC,mBAAmB,CAAC,CAE5B;AAED;;;;;GAKG;AAEH;;;GAGG;AAEH,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACtC,UAAU,EAAE,UAAU,GACrB,yBAAyB,GAAG,mBAAmB,CAiGjD;AAuED,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,mBAAmB,GAAG,mCAAmC,GACvE,MAAM,GAAG,SAAS,CAOpB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAcrG;AAED,oBAAY,4BAA4B,GAAG,SAAS,CAClD,WAAW,EACX;IAAC,UAAU,EAAE;QAAC,CAAC,2BAA2B,CAAC,EAAE,gBAAgB,CAAA;KAAC,CAAA;CAAC,CAChE,CAAC;AAEF,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,MAAM,GACf,4BAA4B,EAAE,CAIhC"}

package/lib/services.js

@@ -0,0 +1,413 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parseV3ServiceStr = parseV3ServiceStr;
+exports.decryptServiceConfig = decryptServiceConfig;
+exports.decryptServiceMap = decryptServiceMap;
+exports.prepareServiceUpdate = prepareServiceUpdate;
+exports.getStoredServiceConfig = getStoredServiceConfig;
+exports.updateServiceConfigV3ToV3_1 = updateServiceConfigV3ToV3_1;
+exports.getServiceNamespace = getServiceNamespace;
+exports.getServiceNamespaces = getServiceNamespaces;
+exports.getServiceObjectFields = getServiceObjectFields;
+
+var _util = require("@takeshape/util");
+
+var _merge = require("@takeshape/util/lib/merge");
+
+var _types = require("./types");
+
+var _v = _interopRequireDefault(require("./schemas/project-schema/v3.1.0.json"));
+
+var _jsonSchema = require("@takeshape/json-schema");
+
+var _isObject = _interopRequireDefault(require("lodash/isObject"));
+
+var _isNull = _interopRequireDefault(require("lodash/isNull"));
+
+var _isString = _interopRequireDefault(require("lodash/isString"));
+
+var _isUndefined = _interopRequireDefault(require("lodash/isUndefined"));
+
+var _schemaUtil = require("./schema-util");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * `graphql:my-key` `my-key`
+ */
+function parseV3ServiceStr(service) {
+  const parts = service.split(':');
+  return {
+    provider: parts.length > 1 ? parts[0] : undefined,
+    id: parts.length > 1 ? parts[1] : parts[0]
+  };
+}
+/**
+ * Given a `StoredServiceConfig` returns a usable `ServiceConfig` with the
+ * authentication object decrypted.
+ */
+
+
+function decryptServiceConfig(decryptFn, storedServiceConfig) {
+  let authentication;
+
+  if ((0, _types.isEncryptedServiceConfig)(storedServiceConfig)) {
+    authentication = decryptFn(storedServiceConfig.authentication);
+  }
+
+  return { ...storedServiceConfig,
+    authentication
+  };
+}
+/**
+ * Given a `StoredServiceMap` returns a usable `ServiceMap` with all the
+ * authentication objects decrypted.
+ */
+
+
+async function decryptServiceMap(decryptFn, storedServiceMap) {
+  return Object.entries(storedServiceMap).reduce((result, [serviceKey, serviceConfig]) => {
+    return result.set(serviceKey, decryptServiceConfig(decryptFn, serviceConfig));
+  }, new Map());
+}
+/**
+ * Provides a `ServiceConfig` validator based on the JSON-schema.
+ */
+
+
+function createServiceConfigValidator() {
+  const {
+    serviceConfig: schema,
+    ...definitions
+  } = _v.default.definitions;
+  const validationSchema = {
+    $id: '#serviceConfig',
+    definitions,
+    ...schema
+  };
+  return (0, _jsonSchema.createSchemaValidator)(validationSchema);
+}
+/**
+ * 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?
+ */
+
+
+function createServiceAuthenticationValidator() {
+  const {
+    serviceAuthentication: schema,
+    ...definitions
+  } = _v.default.definitions;
+  const validationSchema = {
+    $id: '#serviceAuthentication',
+    definitions,
+    ...schema
+  };
+  return (0, _jsonSchema.createSchemaValidator)(validationSchema, [], {
+    removeAdditional: false
+  });
+}
+
+const serviceConfigValidator = createServiceConfigValidator();
+const serviceAuthenticationValidator = createServiceAuthenticationValidator();
+/**
+ * Prepare a `ServiceConfig` object update, validating the overall structure
+ * and encrypting the `ServiceAuthentication` object.
+ */
+// eslint-disable-next-line max-params
+
+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;
+
+  if (storedServiceConfig) {
+    const existingServiceConfig = decryptServiceConfig(decryptFn, storedServiceConfig);
+    newServiceConfig = (0, _merge.mergeWithArrayMerge)(existingServiceConfig, partialServiceConfig);
+  }
+
+  if ((0, _isNull.default)(newServiceConfig.authentication)) {
+    delete newServiceConfig.authentication;
+  }
+
+  let authentication;
+
+  if (newServiceConfig.authentication) {
+    // Copy authentication, to ensure validation doesn't remove any properties
+    authentication = (0, _util.deepClone)(newServiceConfig.authentication);
+    const {
+      errorsText: authenticationErrors
+    } = serviceAuthenticationValidator(authentication);
+
+    if (authenticationErrors) {
+      throw new Error(authenticationErrors);
+    }
+  }
+
+  const {
+    errorsText: configErrors
+  } = serviceConfigValidator(newServiceConfig);
+
+  if (configErrors) {
+    throw new Error(configErrors);
+  }
+
+  let serviceConfig;
+
+  if (authentication) {
+    serviceConfig = { ...newServiceConfig,
+      authentication: encryptFn(authentication)
+    };
+  } else {
+    serviceConfig = newServiceConfig;
+  }
+
+  return serviceConfig;
+}
+/**
+ * Get a service config from a project schema.
+ */
+
+
+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
+
+
+function updateServiceConfigV3ToV3_1(serviceConfig, serviceKey) {
+  if ((0, _types.isAnyServiceConfig)(serviceConfig)) {
+    if ((0, _isString.default)(serviceConfig.authentication) || (0, _isUndefined.default)(serviceConfig.authentication)) {
+      return serviceConfig;
+    }
+
+    return serviceConfig;
+  }
+
+  const auth = serviceConfig.auth;
+  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') {
+    var _serviceParams$namesp;
+
+    provider = 'shopify';
+    authenticationType = 'oauth2Bearer';
+    serviceType = 'graphql';
+    namespace = (_serviceParams$namesp = serviceParams.namespace) !== null && _serviceParams$namesp !== void 0 ? _serviceParams$namesp : 'Shopify';
+  } else if (serviceKeyProvider === 'takeshape') {
+    var _serviceParams$namesp2;
+
+    provider = 'takeshape';
+    authenticationType = 'none';
+    serviceType = 'takeshape';
+    namespace = (_serviceParams$namesp2 = serviceParams.namespace) !== null && _serviceParams$namesp2 !== void 0 ? _serviceParams$namesp2 : 'TakeShape';
+  } else if (serviceKeyProvider === 'bigcommerce') {
+    var _serviceParams$namesp3;
+
+    provider = 'bigcommerce';
+    authenticationType = 'bearer';
+    serviceType = 'graphql';
+    namespace = (_serviceParams$namesp3 = serviceParams.namespace) !== null && _serviceParams$namesp3 !== void 0 ? _serviceParams$namesp3 : 'BigCommerce';
+  } else if (serviceKeyProvider === 'rest') {
+    var _serviceParams$namesp4;
+
+    provider = 'generic';
+    authenticationType = mapAuthType(authType, auth);
+    serviceType = 'rest';
+    namespace = (_serviceParams$namesp4 = serviceParams.namespace) !== null && _serviceParams$namesp4 !== void 0 ? _serviceParams$namesp4 : (0, _util.upperCamel)(title);
+  } else if (serviceKeyProvider === 'graphql') {
+    var _serviceParams$namesp5;
+
+    provider = 'generic';
+    authenticationType = mapAuthType(authType, auth);
+    serviceType = 'graphql';
+    namespace = (_serviceParams$namesp5 = serviceParams.namespace) !== null && _serviceParams$namesp5 !== void 0 ? _serviceParams$namesp5 : (0, _util.upperCamel)(title);
+  } else if (serviceKeyProvider === 'vercel') {
+    provider = 'vercel';
+    authenticationType = 'oauth2Bearer';
+    serviceType = 'deployment';
+  } else if (serviceKeyProvider === 'netlify') {
+    provider = 'netlify';
+    authenticationType = 'oauth2Bearer';
+    serviceType = 'deployment';
+  } else {
+    var _serviceParams$namesp6;
+
+    provider = 'generic';
+    authenticationType = mapAuthType(authType, auth);
+    serviceType = 'unknown';
+    namespace = (_serviceParams$namesp6 = serviceParams.namespace) !== null && _serviceParams$namesp6 !== void 0 ? _serviceParams$namesp6 : (0, _util.upperCamel)(title);
+  }
+
+  const updatedServiceConfig = {
+    title,
+    id: serviceKey,
+    provider,
+    namespace,
+    serviceType,
+    authenticationType,
+    options: { ...serviceParams
+    }
+  };
+
+  if (serviceConfig.auth && (0, _isObject.default)(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';
+}
+
+function getServiceNamespace(serviceConfig) {
+  var _serviceConfig$params;
+
+  if ('namespace' in serviceConfig && serviceConfig.namespace) {
+    return serviceConfig.namespace;
+  }
+
+  if ('params' in serviceConfig && (_serviceConfig$params = serviceConfig.params) !== null && _serviceConfig$params !== void 0 && _serviceConfig$params.namespace) {
+    return serviceConfig.params.namespace;
+  }
+}
+/**
+ * Get a `Map` keyed with all the service namespaces.
+ *
+ * @param context A partial project schema
+ *
+ * @returns A `Map` with namespaces as keys, and service keys as values.
+ */
+
+
+function getServiceNamespaces(context) {
+  let namespaces = new Map();
+  const {
+    services
+  } = context;
+
+  if (services) {
+    Object.keys(services).forEach(serviceKey => {
+      const namespace = getServiceNamespace(services[serviceKey]);
+
+      if (namespace) {
+        namespaces.set(namespace, serviceKey);
+      }
+    });
+  }
+
+  return namespaces;
+}
+
+function getServiceObjectFields(projectSchema, shape, provider) {
+  var _getServiceInfo$provi;
+
+  return ((_getServiceInfo$provi = (0, _schemaUtil.getServiceInfo)(projectSchema, shape)[provider]) !== null && _getServiceInfo$provi !== void 0 ? _getServiceInfo$provi : []).filter(serviceInfo => serviceInfo.generators[_schemaUtil.SERVICE_OBJECT_PATTERN_NAME]);
+}

package/lib/taxonomies.d.ts

@@ -0,0 +1,16 @@
+import type { ProjectSchema, Shape } from './project-schema';
+export interface TaxonomyField {
+    name: string;
+    key?: string;
+}
+export interface Taxonomy {
+    shapeId: string;
+    field: TaxonomyField;
+}
+export declare function getFirstStringFieldV3(shape: Shape, projectSchema: ProjectSchema): {
+    name: string;
+    key?: string;
+} | null;
+export declare const getTaxonomyField: (shape: Shape, projectSchema: ProjectSchema) => TaxonomyField | null;
+export declare const getTaxonomies: (projectSchema: ProjectSchema) => Taxonomy[];
+//# sourceMappingURL=taxonomies.d.ts.map

package/lib/taxonomies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"taxonomies.d.ts","sourceRoot":"","sources":["../../src/taxonomies.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAE,KAAK,EAAC,MAAM,kBAAkB,CAAC;AAI3D,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,aAAa,CAAC;CACtB;AAQD,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,aAAa,GAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAC,GAAG,IAAI,CAUrH;AAED,eAAO,MAAM,gBAAgB,UAAuB,KAAK,iBAAiB,aAAa,KAAG,aAAa,GAAG,IAEzG,CAAC;AAEF,eAAO,MAAM,aAAa,kBAA+B,aAAa,KAAG,QAAQ,EAU/E,CAAC"}

package/lib/taxonomies.js

@@ -0,0 +1,69 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getFirstStringFieldV3 = getFirstStringFieldV3;
+exports.getTaxonomies = exports.getTaxonomyField = void 0;
+
+var _memoize = _interopRequireDefault(require("lodash/memoize"));
+
+var _schemaUtil = require("./schema-util");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function weakMemoize(fn) {
+  const memoized = (0, _memoize.default)(fn);
+  memoized.cache = new WeakMap();
+  return memoized;
+}
+
+function getFirstStringFieldV3(shape, projectSchema) {
+  var _projectSchema$forms;
+
+  const forms = (_projectSchema$forms = projectSchema.forms) === null || _projectSchema$forms === void 0 ? void 0 : _projectSchema$forms[shape.name];
+
+  if (!forms || !forms.default) {
+    return null;
+  }
+
+  const schemaProperties = (0, _schemaUtil.createSchemaPropertyAccessor)(projectSchema, shape.schema);
+  const {
+    order
+  } = forms.default;
+  const name = order.find(name => {
+    var _schemaProperties$get;
+
+    return ((_schemaProperties$get = schemaProperties.getValue(name)) === null || _schemaProperties$get === void 0 ? void 0 : _schemaProperties$get.type) === 'string';
+  });
+  return name ? {
+    name,
+    key: schemaProperties.getKey(name)
+  } : null;
+}
+
+const getTaxonomyField = weakMemoize((shape, projectSchema) => {
+  var _shape$model;
+
+  return ((_shape$model = shape.model) === null || _shape$model === void 0 ? void 0 : _shape$model.type) === 'taxonomy' ? getFirstStringFieldV3(shape, projectSchema) : null;
+});
+exports.getTaxonomyField = getTaxonomyField;
+const getTaxonomies = weakMemoize(projectSchema => {
+  const {
+    shapes
+  } = projectSchema;
+  return Object.keys(shapes).reduce((result, shapeName) => {
+    const shape = shapes[shapeName];
+    const field = getTaxonomyField(shape, projectSchema);
+
+    if (field) {
+      result.push({
+        shapeId: shape.id,
+        field
+      });
+    }
+
+    return result;
+  }, []);
+});
+exports.getTaxonomies = getTaxonomies;

package/lib/template-shapes.d.ts

@@ -0,0 +1,32 @@
+import { ReturnShape } from './project-schema';
+import { ProjectSchemaV3X } from './types';
+import { RefItem } from './refs';
+export declare const knownTemplateShapes: Set<string>;
+/**
+ * Check if a string is a known template such as `PaginatedList`
+ */
+export declare function isValidTemplate(template: string): boolean;
+/**
+ * Parse a template like `PaginatedList<Post>` and return both the template and the shape name.
+ */
+export declare function parseTemplateShape(shape: string): {
+    template: string | undefined;
+    shapeName: string;
+};
+export interface ParsedReturnShape {
+    isArray: boolean;
+    template?: string;
+    shapeName: string;
+    ref?: RefItem;
+}
+export declare function parseReturnShape(projectSchema: ProjectSchemaV3X, shape: ReturnShape): ParsedReturnShape;
+/**
+ * Create a template string like `PaginatedList<Post>` from a template and shape name.
+ */
+export declare function createTemplateShapeName(template: string, shapeName: string): string;
+/**
+ * If the string is a template like `PaginatedList<Post>`, return the shape name,
+ * in this case `Post`. Otherwise return the input.
+ */
+export declare const untemplate: (input: string) => string;
+//# sourceMappingURL=template-shapes.d.ts.map

package/lib/template-shapes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-shapes.d.ts","sourceRoot":"","sources":["../../src/template-shapes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAc,gBAAgB,EAAC,MAAM,SAAS,CAAC;AACtD,OAAO,EAAiC,OAAO,EAAqB,MAAM,QAAQ,CAAC;AAEnF,eAAO,MAAM,mBAAmB,aAa9B,CAAC;AAEH;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG;IAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,CAMnG;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,gBAAgB,EAAE,KAAK,EAAE,WAAW,GAAG,iBAAiB,CAmBvG;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAEnF;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,UAAW,MAAM,WAEvC,CAAC"}