@takeshape/schema 7.194.0

package/lib/template-shapes.js

@@ -0,0 +1,100 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isValidTemplate = isValidTemplate;
+exports.parseTemplateShape = parseTemplateShape;
+exports.parseReturnShape = parseReturnShape;
+exports.createTemplateShapeName = createTemplateShapeName;
+exports.untemplate = exports.knownTemplateShapes = void 0;
+
+var _types = require("./types");
+
+var _refs = require("./refs");
+
+const knownTemplateShapes = new Set(['TSGetArgs', 'TSGetSingletonArgs', 'PaginatedList', 'TSListArgs', 'CreateArgs', 'UpdateArgs', 'DuplicateArgs', 'DeleteArgs', 'CreateResult', 'UpdateResult', 'DuplicateResult', 'DeleteResult']);
+/**
+ * Check if a string is a known template such as `PaginatedList`
+ */
+
+exports.knownTemplateShapes = knownTemplateShapes;
+
+function isValidTemplate(template) {
+  return knownTemplateShapes.has(template);
+}
+/**
+ * Parse a template like `PaginatedList<Post>` and return both the template and the shape name.
+ */
+
+
+function parseTemplateShape(shape) {
+  const parts = shape.split('<');
+
+  if (parts.length > 1 && isValidTemplate(parts[0])) {
+    return {
+      shapeName: parts[1].replace(/(<|>)/, ''),
+      template: parts[0]
+    };
+  }
+
+  return {
+    shapeName: parts[0],
+    template: undefined
+  };
+}
+
+function parseReturnShape(projectSchema, shape) {
+  if (typeof shape === 'object') {
+    if ((0, _types.isRefSchema)(shape.items)) {
+      const ref = (0, _refs.getRef)(projectSchema, shape.items);
+
+      if (!ref) {
+        throw new Error(`Could not parse ${JSON.stringify(shape.items)}: invalid ref`);
+      }
+
+      return {
+        isArray: true,
+        ref,
+        shapeName: (0, _refs.refItemToShapeName)(ref)
+      };
+    }
+
+    if (typeof shape.items.type !== 'string') {
+      throw new Error(`Could not parse ${JSON.stringify(shape.items)}: invalid type`);
+    }
+
+    return {
+      isArray: true,
+      shapeName: shape.items.type
+    };
+  }
+
+  const ref = (0, _refs.refExpressionToRefItem)(projectSchema, shape);
+  const shapeName = (0, _refs.refItemToShapeName)(ref);
+  return {
+    isArray: false,
+    shapeName,
+    ref,
+    template: ref.template
+  };
+}
+/**
+ * Create a template string like `PaginatedList<Post>` from a template and shape name.
+ */
+
+
+function createTemplateShapeName(template, shapeName) {
+  return `${template}<${shapeName}>`;
+}
+/**
+ * If the string is a template like `PaginatedList<Post>`, return the shape name,
+ * in this case `Post`. Otherwise return the input.
+ */
+
+
+const untemplate = input => {
+  return parseTemplateShape(input).shapeName;
+};
+
+exports.untemplate = untemplate;

package/lib/types.d.ts

@@ -0,0 +1,187 @@
+import type { Merge } from 'type-fest';
+import type { AnyProjectSchema, ProjectSchema, ProjectSchemaV1_0_0, ProjectSchemaV3_0_0, ProjectSchemaV3_1_0, ProjectSchemaV3_2_0, ProjectSchemaV3_3_0, ProjectSchemaV3_4_0, ProjectSchemaV3_5_0, ProjectSchemaV3_5_1, ProjectSchemaV3_6_0, Resolver, BasicResolver, ComposeResolver, StoredServiceMap, AnyServiceConfig, ServiceConfig, ContentSchema, Query, ObjectSchema, ArraySchema, AllOfSchema, OneOfSchema, RefSchema, RefSchemaLegacy, ServiceAuthentication, BearerAuthentication, BasicAuthentication, OAuth2Authentication, SearchParamsAuthentication, ContentObjectSchema, CustomAuthentication, DirectiveMappingArray, DirectiveMappingMap, DirectiveConfig } from './project-schema';
+import { Maybe, Overwrite } from '@takeshape/util';
+import { SERVICE_OBJECT_PATTERN_NAME } from './schema-util';
+/**
+ * An alias for the latest version of the project schema. This should be the
+ * only type used in most runtime code. Updating this to a new version should
+ * trigger type errors that clue you in to code that needs review.
+ */
+export declare type ProjectSchemaV3X = ProjectSchemaV3_6_0 | ProjectSchemaV3_5_1 | ProjectSchemaV3_5_0 | ProjectSchemaV3_4_0 | ProjectSchemaV3_3_0 | ProjectSchemaV3_2_0 | ProjectSchemaV3_1_0 | ProjectSchemaV3_0_0;
+export interface Content {
+    [name: string]: any;
+    _id: string;
+}
+export interface ServiceInfo {
+    service: string;
+    fieldName: string;
+    path: string[];
+    generators: Record<typeof SERVICE_OBJECT_PATTERN_NAME, PatternGenerator | undefined>;
+}
+export declare type ServiceSchema = Pick<ProjectSchema, 'shapes' | 'queries' | 'mutations'>;
+export declare function isBasicResolver(resolver: Resolver | undefined): resolver is BasicResolver;
+export declare function isComposeResolver(resolver: Resolver | undefined): resolver is ComposeResolver;
+/**
+ * Remote service configuration types
+ */
+/**
+ * Old service authentication
+ * @deprecated
+ */
+export interface ServiceConfigAccessToken {
+    accessToken: string;
+    refreshToken?: string;
+    scope?: string;
+}
+export declare type ServiceKey = string;
+export declare type ServiceMap = Map<ServiceKey, ServiceConfig>;
+export interface PatternGenerator {
+    version: string;
+    currentVersion: string;
+    idFieldName: string;
+    serviceObjectType: string;
+}
+/**
+ * Test all required props, currently:
+ * "name", "slug", "provider", "serviceType", "authenticationType"
+ */
+export declare function isAnyServiceConfig(maybeConfig: any): maybeConfig is AnyServiceConfig;
+export declare type Headers = Record<string, string | string[]>;
+export declare type RESTServiceConfig = Overwrite<ServiceConfig, {
+    serviceType: 'rest';
+    options: {
+        endpoint: string;
+        headers?: Headers;
+        timeout?: number;
+    };
+}>;
+export declare function isRESTServiceConfig(maybeConfig: any): maybeConfig is RESTServiceConfig;
+export declare type GraphQLServiceConfig = Overwrite<ServiceConfig, {
+    serviceType: 'graphql';
+    options: {
+        [name: string]: any;
+        endpoint: string;
+        headers?: Headers;
+        timeout?: number;
+    };
+}>;
+export declare function isGraphQLServiceConfig(maybeConfig: any): maybeConfig is GraphQLServiceConfig;
+export declare type OpenAPIServiceConfig = Overwrite<ServiceConfig, {
+    serviceType: 'openapi';
+    options: {
+        endpoint: string;
+        spec: string;
+        headers?: Headers;
+        timeout?: number;
+    };
+}>;
+export declare function isOpenAPIServiceConfig(maybeConfig: any): maybeConfig is OpenAPIServiceConfig;
+export declare type EncryptedServiceConfig = Overwrite<ServiceConfig, {
+    authentication: string;
+}>;
+export declare function isEncryptedServiceConfig(maybeConfig: any): maybeConfig is EncryptedServiceConfig;
+export declare function isServiceAuthentication(maybeAuthentication: any): maybeAuthentication is ServiceAuthentication;
+export declare function isBearerAuthentication(maybeAuthentication: any): maybeAuthentication is BearerAuthentication;
+export declare function isBasicAuthentication(maybeAuthentication: any): maybeAuthentication is BasicAuthentication;
+export declare function isSearchParamsAuthentication(maybeAuthentication: any): maybeAuthentication is SearchParamsAuthentication;
+export declare function isOAuth2Authentication(maybeAuthentication: any): maybeAuthentication is OAuth2Authentication;
+export declare type ServiceConfigWithOAuth2Authentication = Merge<ServiceConfig, {
+    authentication: OAuth2Authentication;
+}>;
+export declare function isServiceConfigWithOAuth2Authentication(maybeServiceConfig: any): maybeServiceConfig is ServiceConfigWithOAuth2Authentication;
+export declare type ServiceConfigWithCustomAuthentication = Merge<ServiceConfig, {
+    authentication: CustomAuthentication;
+}>;
+export declare function isServiceConfigWithCustomAuthentication(maybeServiceConfig: any): maybeServiceConfig is ServiceConfigWithCustomAuthentication;
+export interface LatestProjectSchemaWithServices extends ProjectSchema {
+    dataKey: string;
+    services: StoredServiceMap;
+}
+export declare function isProjectSchemaWithServices(schema: ProjectSchema): schema is LatestProjectSchemaWithServices;
+/**
+ * Types of refs
+ */
+export declare enum RefType {
+    '@ref' = "@ref",
+    $ref = "$ref"
+}
+/**
+ * Stub of a ContentSchema that may contain a `$ref` or `@ref`.
+ */
+export interface RefSchemaStub extends Pick<ContentSchema, RefType> {
+    items?: RefSchemaStub;
+}
+export declare type SchemaWithRef = ContentSchema | RefSchemaStub;
+/**
+ * A utility to return the type of ref present on a schema.
+ *
+ * @param refSchema Any schema that may have a `ref` property.
+ */
+export declare const getRefType: (refSchema: SchemaWithRef) => Maybe<RefType>;
+/**
+ * Types of args
+ */
+export declare enum ArgsType {
+    '@args' = "@args",
+    args = "args"
+}
+export declare type SchemaWithArgs = ContentSchema | Query;
+/**
+ * A utility to return the type of args present on a schema.
+ *
+ * @param argsSchema Any schema that may have an `args` property.
+ */
+export declare const getArgsType: (argsSchema: SchemaWithArgs) => Maybe<ArgsType>;
+/**
+ * Typeguards for different types of shape schemas
+ */
+export declare function isRefSchema(maybeRefSchema: ContentObjectSchema | ContentSchema): maybeRefSchema is RefSchema | RefSchemaLegacy;
+export declare function isRefSchemaLegacy(maybeRefSchema: ContentObjectSchema | ContentSchema): maybeRefSchema is RefSchemaLegacy;
+export declare function isAllOfSchema(maybeExtendableSchema: ContentObjectSchema | ContentSchema): maybeExtendableSchema is AllOfSchema;
+export declare function isOneOfSchema(maybeExclusiveOrSchema: ContentObjectSchema | ContentSchema): maybeExclusiveOrSchema is OneOfSchema;
+export declare function isArraySchema(maybeArraySchema: ContentObjectSchema | ContentSchema): maybeArraySchema is ArraySchema;
+export declare function isObjectSchema(maybeObjectSchema: ContentObjectSchema | ContentSchema): maybeObjectSchema is ObjectSchema;
+export declare function isContentObjectSchema(maybeSchema: ContentObjectSchema | ContentSchema): maybeSchema is ContentObjectSchema;
+export declare const isProjectSchemaV1: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchemaV1_0_0;
+export declare const isProjectSchemaV3: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchemaV3_0_0;
+export declare const isProjectSchemaV3_1: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchemaV3_1_0;
+export declare const isProjectSchemaV3_2: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchemaV3_2_0;
+export declare const isProjectSchemaV3_3: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchemaV3_3_0;
+export declare const isProjectSchemaV3_4: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchemaV3_4_0;
+export declare const isProjectSchemaV3_5: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchemaV3_5_0;
+export declare const isProjectSchemaV3_5_1: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchemaV3_5_1;
+export declare const isProjectSchemaV3_6: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchema;
+export declare const isLatestProjectSchema: (projectSchema: AnyProjectSchema) => projectSchema is ProjectSchema;
+/**
+ * Determine whether a given project schema is any project schema.
+ */
+export declare function isAnyProjectSchema(maybeSchema: unknown): maybeSchema is AnyProjectSchema;
+/**
+ * Types supporting schema iterators
+ */
+export declare type SchemaPropertyName = string;
+export declare type SchemaPropertyNode = [SchemaPropertyName, ContentSchema];
+export declare type SchemaPropertyIterator = SchemaPropertyNode[];
+export declare type ShopifyServiceConfig = Overwrite<ServiceConfig, {
+    serviceType: 'graphql';
+    provider: 'shopify';
+    options: {
+        shop: string;
+        endpoint: string;
+    };
+}>;
+export declare function isShopifyServiceConfig(maybeShopify: AnyServiceConfig): maybeShopify is ShopifyServiceConfig;
+export declare type SchemaPath = Array<string | number>;
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveMappingMap
+ */
+export declare function isDirectiveMappingMap(maybeMap: DirectiveMappingMap | DirectiveMappingArray | DirectiveConfig): maybeMap is DirectiveMappingMap;
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveMappingArray
+ */
+export declare function isDirectiveMappingArray(maybeArray: DirectiveMappingMap | DirectiveMappingArray | DirectiveConfig): maybeArray is DirectiveMappingArray;
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveConfig array
+ */
+export declare function isDirectiveConfig(maybeConfig: DirectiveMappingMap | DirectiveMappingArray | DirectiveConfig): maybeConfig is DirectiveConfig;
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,QAAQ,EACR,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,KAAK,EACL,YAAY,EACZ,WAAW,EACX,WAAW,EACX,WAAW,EACX,SAAS,EACT,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAQ1B,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,2BAA2B,EAAC,MAAM,eAAe,CAAC;AAE1D;;;;GAIG;AACH,oBAAY,gBAAgB,GACxB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,CAAC;AAExB,MAAM,WAAW,OAAO;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,EAAE,MAAM,CAAC,OAAO,2BAA2B,EAAE,gBAAgB,GAAG,SAAS,CAAC,CAAC;CACtF;AAED,oBAAY,aAAa,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC,CAAC;AAEpF,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,IAAI,aAAa,CAEzF;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,IAAI,eAAe,CAE7F;AAED;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,UAAU,GAAG,MAAM,CAAC;AAChC,oBAAY,UAAU,GAAG,GAAG,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;AAExD,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,GAAG,GAAG,WAAW,IAAI,gBAAgB,CASpF;AAED,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;AAExD,oBAAY,iBAAiB,GAAG,SAAS,CACvC,aAAa,EACb;IACE,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CACF,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,GAAG,GAAG,WAAW,IAAI,iBAAiB,CAEtF;AAED,oBAAY,oBAAoB,GAAG,SAAS,CAC1C,aAAa,EACb;IACE,WAAW,EAAE,SAAS,CAAC;IACvB,OAAO,EAAE;QACP,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CACF,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,GAAG,GAAG,WAAW,IAAI,oBAAoB,CAI5F;AAED,oBAAY,oBAAoB,GAAG,SAAS,CAC1C,aAAa,EACb;IACE,WAAW,EAAE,SAAS,CAAC;IACvB,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CACF,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,GAAG,GAAG,WAAW,IAAI,oBAAoB,CAE5F;AAED,oBAAY,sBAAsB,GAAG,SAAS,CAC5C,aAAa,EACb;IACE,cAAc,EAAE,MAAM,CAAC;CACxB,CACF,CAAC;AAEF,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,GAAG,GAAG,WAAW,IAAI,sBAAsB,CAEhG;AAED,wBAAgB,uBAAuB,CAAC,mBAAmB,EAAE,GAAG,GAAG,mBAAmB,IAAI,qBAAqB,CAE9G;AAED,wBAAgB,sBAAsB,CAAC,mBAAmB,EAAE,GAAG,GAAG,mBAAmB,IAAI,oBAAoB,CAE5G;AAED,wBAAgB,qBAAqB,CAAC,mBAAmB,EAAE,GAAG,GAAG,mBAAmB,IAAI,mBAAmB,CAM1G;AAED,wBAAgB,4BAA4B,CAC1C,mBAAmB,EAAE,GAAG,GACvB,mBAAmB,IAAI,0BAA0B,CAQnD;AAED,wBAAgB,sBAAsB,CAAC,mBAAmB,EAAE,GAAG,GAAG,mBAAmB,IAAI,oBAAoB,CAI5G;AAED,oBAAY,qCAAqC,GAAG,KAAK,CACvD,aAAa,EACb;IACE,cAAc,EAAE,oBAAoB,CAAC;CACtC,CACF,CAAC;AAEF,wBAAgB,uCAAuC,CACrD,kBAAkB,EAAE,GAAG,GACtB,kBAAkB,IAAI,qCAAqC,CAM7D;AAED,oBAAY,qCAAqC,GAAG,KAAK,CACvD,aAAa,EACb;IACE,cAAc,EAAE,oBAAoB,CAAC;CACtC,CACF,CAAC;AAEF,wBAAgB,uCAAuC,CACrD,kBAAkB,EAAE,GAAG,GACtB,kBAAkB,IAAI,qCAAqC,CAM7D;AAED,MAAM,WAAW,+BAAgC,SAAQ,aAAa;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAED,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,IAAI,+BAA+B,CAE5G;AAED;;GAEG;AACH,oBAAY,OAAO;IACjB,MAAM,SAAS;IACf,IAAI,SAAS;CACd;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC;IACjE,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,oBAAY,aAAa,GAAG,aAAa,GAAG,aAAa,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,UAAU,cAAe,aAAa,KAAG,MAAM,OAAO,CAQlE,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ;IAClB,OAAO,UAAU;IACjB,IAAI,SAAS;CACd;AAED,oBAAY,cAAc,GAAG,aAAa,GAAG,KAAK,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,WAAW,eAAgB,cAAc,KAAG,MAAM,QAAQ,CAQtE,CAAC;AAEF;;GAEG;AAEH,wBAAgB,WAAW,CACzB,cAAc,EAAE,mBAAmB,GAAG,aAAa,GAClD,cAAc,IAAI,SAAS,GAAG,eAAe,CAE/C;AAED,wBAAgB,iBAAiB,CAC/B,cAAc,EAAE,mBAAmB,GAAG,aAAa,GAClD,cAAc,IAAI,eAAe,CAEnC;AAED,wBAAgB,aAAa,CAC3B,qBAAqB,EAAE,mBAAmB,GAAG,aAAa,GACzD,qBAAqB,IAAI,WAAW,CAEtC;AAED,wBAAgB,aAAa,CAC3B,sBAAsB,EAAE,mBAAmB,GAAG,aAAa,GAC1D,sBAAsB,IAAI,WAAW,CAEvC;AAED,wBAAgB,aAAa,CAAC,gBAAgB,EAAE,mBAAmB,GAAG,aAAa,GAAG,gBAAgB,IAAI,WAAW,CAEpH;AAED,wBAAgB,cAAc,CAC5B,iBAAiB,EAAE,mBAAmB,GAAG,aAAa,GACrD,iBAAiB,IAAI,YAAY,CAInC;AAED,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,mBAAmB,GAAG,aAAa,GAC/C,WAAW,IAAI,mBAAmB,CAEpC;AAYD,eAAO,MAAM,iBAAiB,kBANL,gBAAgB,yCAMwC,CAAC;AAClF,eAAO,MAAM,iBAAiB,kBAPL,gBAAgB,yCAOwC,CAAC;AAClF,eAAO,MAAM,mBAAmB,kBARP,gBAAgB,yCAQ8C,CAAC;AACxF,eAAO,MAAM,mBAAmB,kBATP,gBAAgB,yCAS8C,CAAC;AACxF,eAAO,MAAM,mBAAmB,kBAVP,gBAAgB,yCAU8C,CAAC;AACxF,eAAO,MAAM,mBAAmB,kBAXP,gBAAgB,yCAW8C,CAAC;AACxF,eAAO,MAAM,mBAAmB,kBAZP,gBAAgB,yCAY8C,CAAC;AACxF,eAAO,MAAM,qBAAqB,kBAbT,gBAAgB,yCAagD,CAAC;AAC1F,eAAO,MAAM,mBAAmB,kBAdP,gBAAgB,mCAc8C,CAAC;AACxF,eAAO,MAAM,qBAAqB,kBAfT,gBAAgB,mCAeyD,CAAC;AAEnG;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,OAAO,GAAG,WAAW,IAAI,gBAAgB,CAcxF;AAED;;GAEG;AACH,oBAAY,kBAAkB,GAAG,MAAM,CAAC;AACxC,oBAAY,kBAAkB,GAAG,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;AACrE,oBAAY,sBAAsB,GAAG,kBAAkB,EAAE,CAAC;AAE1D,oBAAY,oBAAoB,GAAG,SAAS,CAC1C,aAAa,EACb;IACE,WAAW,EAAE,SAAS,CAAC;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CACF,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,gBAAgB,GAAG,YAAY,IAAI,oBAAoB,CAE3G;AAED,oBAAY,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAEhD;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,mBAAmB,GAAG,qBAAqB,GAAG,eAAe,GACtE,QAAQ,IAAI,mBAAmB,CAEjC;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,mBAAmB,GAAG,qBAAqB,GAAG,eAAe,GACxE,UAAU,IAAI,qBAAqB,CAErC;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,mBAAmB,GAAG,qBAAqB,GAAG,eAAe,GACzE,WAAW,IAAI,eAAe,CAEhC"}

package/lib/types.js

@@ -0,0 +1,289 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isBasicResolver = isBasicResolver;
+exports.isComposeResolver = isComposeResolver;
+exports.isAnyServiceConfig = isAnyServiceConfig;
+exports.isRESTServiceConfig = isRESTServiceConfig;
+exports.isGraphQLServiceConfig = isGraphQLServiceConfig;
+exports.isOpenAPIServiceConfig = isOpenAPIServiceConfig;
+exports.isEncryptedServiceConfig = isEncryptedServiceConfig;
+exports.isServiceAuthentication = isServiceAuthentication;
+exports.isBearerAuthentication = isBearerAuthentication;
+exports.isBasicAuthentication = isBasicAuthentication;
+exports.isSearchParamsAuthentication = isSearchParamsAuthentication;
+exports.isOAuth2Authentication = isOAuth2Authentication;
+exports.isServiceConfigWithOAuth2Authentication = isServiceConfigWithOAuth2Authentication;
+exports.isServiceConfigWithCustomAuthentication = isServiceConfigWithCustomAuthentication;
+exports.isProjectSchemaWithServices = isProjectSchemaWithServices;
+exports.isRefSchema = isRefSchema;
+exports.isRefSchemaLegacy = isRefSchemaLegacy;
+exports.isAllOfSchema = isAllOfSchema;
+exports.isOneOfSchema = isOneOfSchema;
+exports.isArraySchema = isArraySchema;
+exports.isObjectSchema = isObjectSchema;
+exports.isContentObjectSchema = isContentObjectSchema;
+exports.isAnyProjectSchema = isAnyProjectSchema;
+exports.isShopifyServiceConfig = isShopifyServiceConfig;
+exports.isDirectiveMappingMap = isDirectiveMappingMap;
+exports.isDirectiveMappingArray = isDirectiveMappingArray;
+exports.isDirectiveConfig = isDirectiveConfig;
+exports.isLatestProjectSchema = exports.isProjectSchemaV3_6 = exports.isProjectSchemaV3_5_1 = exports.isProjectSchemaV3_5 = exports.isProjectSchemaV3_4 = exports.isProjectSchemaV3_3 = exports.isProjectSchemaV3_2 = exports.isProjectSchemaV3_1 = exports.isProjectSchemaV3 = exports.isProjectSchemaV1 = exports.getArgsType = exports.ArgsType = exports.getRefType = exports.RefType = void 0;
+
+var _eq = _interopRequireDefault(require("semver/functions/eq"));
+
+var _coerce = _interopRequireDefault(require("semver/functions/coerce"));
+
+var _has = _interopRequireDefault(require("lodash/has"));
+
+var _isString = _interopRequireDefault(require("lodash/isString"));
+
+var _isObject = _interopRequireDefault(require("lodash/isObject"));
+
+var _isArray = _interopRequireDefault(require("lodash/isArray"));
+
+var _isPlainObject = _interopRequireDefault(require("lodash/isPlainObject"));
+
+var _versions = require("./versions");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function isBasicResolver(resolver) {
+  return resolver ? (0, _isString.default)(resolver.name) && (0, _isString.default)(resolver.service) : false;
+}
+
+function isComposeResolver(resolver) {
+  return resolver ? resolver.compose !== undefined : false;
+}
+/**
+ * Remote service configuration types
+ */
+
+/**
+ * Old service authentication
+ * @deprecated
+ */
+
+
+/**
+ * Test all required props, currently:
+ * "name", "slug", "provider", "serviceType", "authenticationType"
+ */
+function isAnyServiceConfig(maybeConfig) {
+  return maybeConfig && (0, _isString.default)(maybeConfig.title) && (0, _isString.default)(maybeConfig.id) && (0, _isString.default)(maybeConfig.provider) && (0, _isString.default)(maybeConfig.serviceType) && (0, _isString.default)(maybeConfig.authenticationType);
+}
+
+function isRESTServiceConfig(maybeConfig) {
+  return isAnyServiceConfig(maybeConfig) && maybeConfig.serviceType === 'rest';
+}
+
+function isGraphQLServiceConfig(maybeConfig) {
+  var _maybeConfig$options;
+
+  return isAnyServiceConfig(maybeConfig) && maybeConfig.serviceType === 'graphql' && (0, _isString.default)((_maybeConfig$options = maybeConfig.options) === null || _maybeConfig$options === void 0 ? void 0 : _maybeConfig$options.endpoint);
+}
+
+function isOpenAPIServiceConfig(maybeConfig) {
+  return isAnyServiceConfig(maybeConfig) && maybeConfig.serviceType === 'openapi';
+}
+
+function isEncryptedServiceConfig(maybeConfig) {
+  return isAnyServiceConfig(maybeConfig) && (0, _isString.default)(maybeConfig.authentication);
+}
+
+function isServiceAuthentication(maybeAuthentication) {
+  return maybeAuthentication && (0, _isObject.default)(maybeAuthentication);
+}
+
+function isBearerAuthentication(maybeAuthentication) {
+  return isServiceAuthentication(maybeAuthentication) && (0, _isString.default)(maybeAuthentication.token);
+}
+
+function isBasicAuthentication(maybeAuthentication) {
+  return isServiceAuthentication(maybeAuthentication) && ((0, _isString.default)(maybeAuthentication.username) || (0, _isString.default)(maybeAuthentication.password));
+}
+
+function isSearchParamsAuthentication(maybeAuthentication) {
+  return (0, _isArray.default)(maybeAuthentication) && maybeAuthentication.every(value => (0, _isObject.default)(value) && Object.entries(value).every(([k, v]) => (k === 'name' || k === 'value') && (0, _isString.default)(v)));
+}
+
+function isOAuth2Authentication(maybeAuthentication) {
+  return isServiceAuthentication(maybeAuthentication) && (0, _isString.default)(maybeAuthentication.clientId);
+}
+
+function isServiceConfigWithOAuth2Authentication(maybeServiceConfig) {
+  return isAnyServiceConfig(maybeServiceConfig) && maybeServiceConfig.authenticationType === 'oauth2' && isOAuth2Authentication(maybeServiceConfig.authentication);
+}
+
+function isServiceConfigWithCustomAuthentication(maybeServiceConfig) {
+  return isAnyServiceConfig(maybeServiceConfig) && maybeServiceConfig.authenticationType === 'custom' && isServiceAuthentication(maybeServiceConfig.authentication);
+}
+
+function isProjectSchemaWithServices(schema) {
+  return typeof schema.dataKey !== 'undefined' && typeof schema.services !== 'undefined';
+}
+/**
+ * Types of refs
+ */
+
+
+let RefType;
+/**
+ * Stub of a ContentSchema that may contain a `$ref` or `@ref`.
+ */
+
+exports.RefType = RefType;
+
+(function (RefType) {
+  RefType["@ref"] = "@ref";
+  RefType["$ref"] = "$ref";
+})(RefType || (exports.RefType = RefType = {}));
+
+/**
+ * A utility to return the type of ref present on a schema.
+ *
+ * @param refSchema Any schema that may have a `ref` property.
+ */
+const getRefType = refSchema => {
+  if ((0, _has.default)(refSchema, '@ref')) {
+    return RefType['@ref'];
+  }
+
+  if ((0, _has.default)(refSchema, '$ref')) {
+    return RefType.$ref;
+  }
+};
+/**
+ * Types of args
+ */
+
+
+exports.getRefType = getRefType;
+let ArgsType;
+exports.ArgsType = ArgsType;
+
+(function (ArgsType) {
+  ArgsType["@args"] = "@args";
+  ArgsType["args"] = "args";
+})(ArgsType || (exports.ArgsType = ArgsType = {}));
+
+/**
+ * A utility to return the type of args present on a schema.
+ *
+ * @param argsSchema Any schema that may have an `args` property.
+ */
+const getArgsType = argsSchema => {
+  if ((0, _has.default)(argsSchema, '@args')) {
+    return ArgsType['@args'];
+  }
+
+  if ((0, _has.default)(argsSchema, 'args')) {
+    return ArgsType.args;
+  }
+};
+/**
+ * Typeguards for different types of shape schemas
+ */
+
+
+exports.getArgsType = getArgsType;
+
+function isRefSchema(maybeRefSchema) {
+  return (0, _isString.default)(maybeRefSchema['@ref']) || (0, _isString.default)(maybeRefSchema.$ref);
+}
+
+function isRefSchemaLegacy(maybeRefSchema) {
+  return (0, _isString.default)(maybeRefSchema.$ref);
+}
+
+function isAllOfSchema(maybeExtendableSchema) {
+  return (0, _isArray.default)(maybeExtendableSchema.allOf);
+}
+
+function isOneOfSchema(maybeExclusiveOrSchema) {
+  return (0, _isArray.default)(maybeExclusiveOrSchema.oneOf);
+}
+
+function isArraySchema(maybeArraySchema) {
+  return maybeArraySchema.type === 'array' && (0, _isObject.default)(maybeArraySchema.items);
+}
+
+function isObjectSchema(maybeObjectSchema) {
+  return maybeObjectSchema.type === 'object' && (0, _isObject.default)(maybeObjectSchema.properties);
+}
+
+function isContentObjectSchema(maybeSchema) {
+  return isRefSchema(maybeSchema) || isAllOfSchema(maybeSchema) || isObjectSchema(maybeSchema);
+}
+
+function createVersionPredicate(schemaVersion) {
+  const expectedSemver = (0, _coerce.default)(schemaVersion);
+  return projectSchema => {
+    var _projectSchema$schema;
+
+    const schemaSemver = (0, _coerce.default)((_projectSchema$schema = projectSchema.schemaVersion) !== null && _projectSchema$schema !== void 0 ? _projectSchema$schema : '1');
+    return Boolean(expectedSemver && schemaSemver && (0, _eq.default)(schemaSemver, expectedSemver));
+  };
+}
+
+const isProjectSchemaV1 = createVersionPredicate('1');
+exports.isProjectSchemaV1 = isProjectSchemaV1;
+const isProjectSchemaV3 = createVersionPredicate('3');
+exports.isProjectSchemaV3 = isProjectSchemaV3;
+const isProjectSchemaV3_1 = createVersionPredicate('3.1.0');
+exports.isProjectSchemaV3_1 = isProjectSchemaV3_1;
+const isProjectSchemaV3_2 = createVersionPredicate('3.2.0');
+exports.isProjectSchemaV3_2 = isProjectSchemaV3_2;
+const isProjectSchemaV3_3 = createVersionPredicate('3.3.0');
+exports.isProjectSchemaV3_3 = isProjectSchemaV3_3;
+const isProjectSchemaV3_4 = createVersionPredicate('3.4.0');
+exports.isProjectSchemaV3_4 = isProjectSchemaV3_4;
+const isProjectSchemaV3_5 = createVersionPredicate('3.5.0');
+exports.isProjectSchemaV3_5 = isProjectSchemaV3_5;
+const isProjectSchemaV3_5_1 = createVersionPredicate('3.5.1');
+exports.isProjectSchemaV3_5_1 = isProjectSchemaV3_5_1;
+const isProjectSchemaV3_6 = createVersionPredicate('3.6.0');
+exports.isProjectSchemaV3_6 = isProjectSchemaV3_6;
+const isLatestProjectSchema = createVersionPredicate(_versions.CURRENT_SCHEMA_VERSION);
+/**
+ * Determine whether a given project schema is any project schema.
+ */
+
+exports.isLatestProjectSchema = isLatestProjectSchema;
+
+function isAnyProjectSchema(maybeSchema) {
+  return (0, _isObject.default)(maybeSchema) && (0, _isString.default)(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));
+}
+/**
+ * Types supporting schema iterators
+ */
+
+
+function isShopifyServiceConfig(maybeShopify) {
+  return maybeShopify.provider === 'shopify';
+}
+
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveMappingMap
+ */
+function isDirectiveMappingMap(maybeMap) {
+  return (0, _isPlainObject.default)(maybeMap) && Object.keys(maybeMap).length > 0;
+}
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveMappingArray
+ */
+
+
+function isDirectiveMappingArray(maybeArray) {
+  return (0, _isArray.default)(maybeArray) && (0, _isArray.default)(maybeArray[0]) && (0, _isString.default)(maybeArray[0][0]) && (0, _isArray.default)(maybeArray[0][1]);
+}
+/**
+ * Determine whether the ambiguous Directive structure is a DirectiveConfig array
+ */
+
+
+function isDirectiveConfig(maybeConfig) {
+  return (0, _isArray.default)(maybeConfig) && (0, _isArray.default)(maybeConfig[0]) && (0, _isString.default)(maybeConfig[0][0]) && (0, _isObject.default)(maybeConfig[0][1]);
+}

package/lib/unions.d.ts

@@ -0,0 +1,29 @@
+import { ProjectSchema, ContentSchema, ObjectSchema, OneOfSchema } from './project-schema';
+import { PropertyTransform } from './content-schema-transform';
+import { ProjectSchemaV3X } from './types';
+export interface UnionedShape {
+    propName: string;
+    shapeName: string;
+    shapeId: string;
+    propSchema: ContentSchema;
+}
+export declare function enumerateOneOfKeys(projectSchema: ProjectSchemaV3X, oneOf: ContentSchema[]): UnionedShape[];
+export declare function isUnionSchema(schema: ContentSchema): schema is OneOfSchema;
+export declare function oneOfToObject(projectSchema: ProjectSchemaV3X, schema: ContentSchema): ObjectSchema;
+export declare type TransformProcessFactory = (projectSchema: ProjectSchema) => PropertyTransform['process'];
+export declare const createUnwrapTransform: TransformProcessFactory;
+export declare const createWrapTransform: TransformProcessFactory;
+export declare function transformOneOf(process: TransformProcessFactory): (projectSchema: ProjectSchema, schema: ContentSchema, obj: Record<string, unknown>) => Record<string, unknown>;
+/**
+ * Unwrap oneOf objects in "GraphQL oneOf" style wrapper objects
+ * See https://github.com/graphql/graphql-spec/pull/825 for more on "GraphQL oneOf"
+ * Opposite of `wrapOneOfObjects`
+ */
+export declare const unwrapOneOfObjects: (projectSchema: ProjectSchema, schema: ContentSchema, obj: Record<string, unknown>) => Record<string, unknown>;
+/**
+ * Wrap oneOf objects in "GraphQL oneOf" style wrapper objects
+ * See https://github.com/graphql/graphql-spec/pull/825 for more on "GraphQL oneOf"
+ * Opposite of `unwrapOneOfObjects`
+ */
+export declare const wrapOneOfObjects: (projectSchema: ProjectSchema, schema: ContentSchema, obj: Record<string, unknown>) => Record<string, unknown>;
+//# sourceMappingURL=unions.d.ts.map

package/lib/unions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unions.d.ts","sourceRoot":"","sources":["../../src/unions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAC,MAAM,kBAAkB,CAAC;AAIzF,OAAO,EAAsB,iBAAiB,EAAS,MAAM,4BAA4B,CAAC;AAC1F,OAAO,EAAc,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAItD,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,aAAa,CAAC;CAC3B;AAED,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,YAAY,EAAE,CAkB1G;AASD,wBAAgB,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,IAAI,WAAW,CAE1E;AAED,wBAAgB,aAAa,CAAC,aAAa,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,GAAG,YAAY,CAMlG;AAMD,oBAAY,uBAAuB,GAAG,CAAC,aAAa,EAAE,aAAa,KAAK,iBAAiB,CAAC,SAAS,CAAC,CAAC;AAGrG,eAAO,MAAM,qBAAqB,EAAE,uBAyBnC,CAAC;AAGF,eAAO,MAAM,mBAAmB,EAAE,uBASjC,CAAC;AAEF,wBAAgB,cAAc,CAAC,OAAO,EAAE,uBAAuB,mBAE5C,aAAa,UACpB,aAAa,OAChB,OAAO,MAAM,EAAE,OAAO,CAAC,KAC3B,OAAO,MAAM,EAAE,OAAO,CAAC,CAiB3B;AAED;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,kBA3BZ,aAAa,UACpB,aAAa,OAChB,OAAO,MAAM,EAAE,OAAO,CAAC,KAC3B,OAAO,MAAM,EAAE,OAAO,CAwB4C,CAAC;AAExE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,kBAlCV,aAAa,UACpB,aAAa,OAChB,OAAO,MAAM,EAAE,OAAO,CAAC,KAC3B,OAAO,MAAM,EAAE,OAAO,CA+BwC,CAAC"}