@bobbykim/manguito-cms-api 0.5.0 → 0.7.0

package/dist/graphql/index.js

@@ -148,10 +148,13 @@ var SORTABLE = [
   { gql: "createdAt", value: "created_at" },
   { gql: "updatedAt", value: "updated_at" }
 ];
-function buildSortFieldEnum(typeName) {
+function buildSortFieldEnum(typeName, fieldKeys) {
+  const resolvable = SORTABLE.filter(
+    (s) => s.gql === "createdAt" || s.gql === "updatedAt" || fieldKeys === void 0 || fieldKeys.columnFor(s.value) !== void 0
+  );
   return new import_graphql3.GraphQLEnumType({
     name: `${typeName}SortField`,
-    values: Object.fromEntries(SORTABLE.map((s) => [s.gql, { value: s.value }]))
+    values: Object.fromEntries(resolvable.map((s) => [s.gql, { value: s.value }]))
   });
 }
 function comparableFilterInput(name, scalar) {
@@ -195,18 +198,19 @@ function filterInputForField(fieldType) {
   if (scalar === null) return null;
   return StringFilter;
 }
-function buildFilterInputType(type) {
+function buildFilterInputType(type, viewFields) {
   const fields = {};
   fields["id"] = { type: IDFilter };
   fields["published"] = { type: BooleanFilter };
   fields["createdAt"] = { type: DateTimeFilter };
   fields["updatedAt"] = { type: DateTimeFilter };
   if (type.schema_type === "content-type") fields["slug"] = { type: StringFilter };
-  for (const f of type.fields) {
+  const entries = viewFields !== void 0 ? viewFields.map((v) => ({ field: v.field, exposedAs: v.exposedAs })) : type.fields.filter((f) => f.removed !== true).map((f) => ({ field: f, exposedAs: f.name }));
+  for (const { field: f, exposedAs } of entries) {
     if (f.field_type === "programmatic" || f.field_type === "paragraph") continue;
     if (f.field_type === "image" || f.field_type === "video" || f.field_type === "file") continue;
     const input = filterInputForField(f.field_type);
-    if (input) fields[buildFieldNameMap([f.name]).toGraphql(f.name)] = { type: input };
+    if (input) fields[buildFieldNameMap([exposedAs]).toGraphql(exposedAs)] = { type: input };
   }
   if (Object.keys(fields).length === 0) return null;
   return new import_graphql3.GraphQLInputObjectType({ name: `${graphqlTypeName(type.name)}Filter`, fields });
@@ -253,12 +257,14 @@ function codeError(code, message) {
 function isPublished(item) {
   return !!item && item["published"] === true;
 }
-function resolveFieldValue(field, row) {
+function resolveFieldValue(field, row, fallback) {
   const key = isColumnBacked(field) ? field.db_column.column_name : field.name;
-  return row[key] ?? null;
+  const value = row[key];
+  if ((value === null || value === void 0) && fallback !== void 0) return fallback;
+  return value ?? null;
 }
-function scalarFieldResolver(field) {
-  return (parent) => resolveFieldValue(field, parent);
+function scalarFieldResolver(field, fallback) {
+  return (parent) => resolveFieldValue(field, parent, fallback);
 }
 function relationFieldResolver(typeName, schemaFieldName) {
   return (parent, _args, ctx) => ctx.loaders.load(typeName, schemaFieldName, parent);
@@ -352,7 +358,7 @@ var MEDIA = new import_graphql5.GraphQLObjectType({
     duration: { type: import_graphql5.GraphQLInt, resolve: (m) => m.duration }
   }
 });
-function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
+function buildGraphQLSchema(registry, fieldKeyMaps = {}, view, programmaticKeyMaps = fieldKeyMaps) {
   const objectTypes = /* @__PURE__ */ new Map();
   const enumTypes = /* @__PURE__ */ new Map();
   for (const [name, enumType] of Object.entries(registry.enum_types)) {
@@ -371,14 +377,14 @@ function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
       );
     }
   }
-  function outputTypeForField(field) {
+  function outputTypeForField(field, required) {
     const scalar = scalarOutputType(field.field_type);
-    if (scalar) return field.required ? new import_graphql5.GraphQLNonNull(scalar) : scalar;
+    if (scalar) return required ? new import_graphql5.GraphQLNonNull(scalar) : scalar;
     if (field.field_type === "enum") {
       const ref = field.ui_component.component === "select" ? field.ui_component.enum_ref : void 0;
       const et = ref ? enumTypes.get(ref) : void 0;
       const t = et ?? import_graphql5.GraphQLString;
-      return field.required ? new import_graphql5.GraphQLNonNull(t) : t;
+      return required ? new import_graphql5.GraphQLNonNull(t) : t;
     }
     if (field.field_type === "image" || field.field_type === "video" || field.field_type === "file") {
       return MEDIA;
@@ -408,8 +414,17 @@ function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
     }
     return import_graphql5.GraphQLString;
   }
+  function exposedFields(type) {
+    return type.fields.filter((f) => f.removed !== true);
+  }
+  function viewFieldsFor(machineName, type) {
+    return view?.[machineName]?.fields ?? exposedFields(type).map((f) => ({ field: f, exposedAs: f.name, required: f.required }));
+  }
   function buildObjectType(machineName, type) {
-    const mediaFieldNames = type.fields.filter((f) => f.field_type === "image" || f.field_type === "video" || f.field_type === "file").map((f) => f.name);
+    const visible = viewFieldsFor(machineName, type);
+    const mediaFieldNames = type.fields.filter(
+      (f) => f.removed !== true && (f.field_type === "image" || f.field_type === "video" || f.field_type === "file")
+    ).map((f) => f.name);
     return new import_graphql5.GraphQLObjectType({
       name: graphqlTypeName(machineName),
       fields: () => {
@@ -423,23 +438,25 @@ function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
         }
         fields["createdAt"] = { type: new import_graphql5.GraphQLNonNull(DateTimeScalar), resolve: (p) => p["created_at"] };
         fields["updatedAt"] = { type: new import_graphql5.GraphQLNonNull(DateTimeScalar), resolve: (p) => p["updated_at"] };
-        for (const field of type.fields) {
-          const gqlName = toCamelCase(field.name);
-          const outType = outputTypeForField(field);
+        for (const vf of visible) {
+          const field = vf.field;
+          const gqlName = toCamelCase(vf.exposedAs);
+          const outType = outputTypeForField(field, vf.required);
           let resolve;
           if (field.field_type === "programmatic") {
-            resolve = programmaticFieldResolver(
-              machineName,
-              field.name,
-              mediaFieldNames,
-              fieldKeyMaps[machineName]
-            );
+            resolve = programmaticFieldResolver(machineName, field.name, mediaFieldNames, programmaticKeyMaps[machineName]);
           } else if (field.field_type === "reference" || field.field_type === "paragraph" || field.field_type === "image" || field.field_type === "video" || field.field_type === "file") {
             resolve = relationFieldResolver(machineName, field.name);
           } else {
-            resolve = scalarFieldResolver(field);
+            resolve = scalarFieldResolver(field, vf.fallback);
           }
-          fields[gqlName] = { type: outType, resolve };
+          fields[gqlName] = {
+            type: outType,
+            resolve,
+            // Conditional spread, not `deprecationReason: vf.deprecationReason`
+            // — exactOptionalPropertyTypes forbids present-and-undefined.
+            ...vf.deprecationReason !== void 0 && { deprecationReason: vf.deprecationReason }
+          };
         }
         return fields;
       }
@@ -471,7 +488,11 @@ function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
   const queryFields = {};
   for (const [name, ct] of Object.entries(registry.content_types)) {
     const objType = objectTypes.get(name);
-    const nameMap = buildFieldNameMap(ct.fields.map((f) => f.name));
+    const visible = viewFieldsFor(name, ct);
+    const nameMap = buildFieldNameMap([
+      ...visible.map((v) => v.exposedAs),
+      ...ct.system_fields.map((s) => s.name)
+    ]);
     if (ct.only_one) {
       queryFields[singleQueryName(name)] = { type: objType, resolve: singletonResolver(name) };
       continue;
@@ -483,13 +504,13 @@ function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
         meta: { type: new import_graphql5.GraphQLNonNull(PAGE_META), resolve: (r) => r.meta }
       }
     });
-    const filterType = buildFilterInputType(ct);
+    const filterType = buildFilterInputType(ct, visible);
     queryFields[collectionQueryName(name)] = {
       type: new import_graphql5.GraphQLNonNull(listType),
       args: {
         page: { type: import_graphql5.GraphQLInt },
         perPage: { type: import_graphql5.GraphQLInt },
-        sortBy: { type: buildSortFieldEnum(graphqlTypeName(name)) },
+        sortBy: { type: buildSortFieldEnum(graphqlTypeName(name), fieldKeyMaps[name]) },
         sortOrder: { type: SortOrderEnum },
         ...filterType ? { filter: { type: filterType } } : {}
       },
@@ -513,7 +534,11 @@ function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
     queryFields[collectionQueryName(name)] = {
       type: new import_graphql5.GraphQLNonNull(listType),
       args: { page: { type: import_graphql5.GraphQLInt }, perPage: { type: import_graphql5.GraphQLInt } },
-      resolve: collectionResolver(name, buildFieldNameMap(tt.fields.map((f) => f.name)), fieldKeyMaps[name])
+      resolve: collectionResolver(
+        name,
+        buildFieldNameMap(viewFieldsFor(name, tt).map((v) => v.exposedAs)),
+        fieldKeyMaps[name]
+      )
     };
     queryFields[singleQueryName(name)] = {
       type: objType,
@@ -526,6 +551,70 @@ function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
   });
 }
 
+// src/graphql/version-view.ts
+function byColumn(fields) {
+  const out = /* @__PURE__ */ new Map();
+  for (const f of fields) {
+    if (!isColumnBacked(f)) continue;
+    out.set(f.db_column.column_name, f);
+  }
+  return out;
+}
+function deprecationFor(field, currentLabels, currentVersion) {
+  const currentLabel = currentLabels.get(field.column_name);
+  if (currentLabel === void 0) {
+    return `Removed in ${currentVersion}; column retained while this version is live.`;
+  }
+  if (currentLabel !== field.exposed_as) {
+    return `Renamed to '${currentLabel}' in ${currentVersion}.`;
+  }
+  return void 0;
+}
+function buildVersionView(input) {
+  const { registry, projection, currentProjection, currentVersion } = input;
+  const out = {};
+  const sources = [
+    registry.content_types,
+    registry.taxonomy_types,
+    registry.paragraph_types
+  ];
+  for (const source of sources) {
+    for (const [typeName, type] of Object.entries(source)) {
+      const projectionType = projection?.types[typeName];
+      if (projectionType === void 0) {
+        out[typeName] = {
+          fields: type.fields.filter((f) => f.removed !== true).map((f) => ({ field: f, exposedAs: f.name, required: f.required }))
+        };
+        continue;
+      }
+      const columns = byColumn(type.fields);
+      const currentLabels = /* @__PURE__ */ new Map();
+      for (const f of currentProjection?.types[typeName]?.fields ?? []) {
+        currentLabels.set(f.column_name, f.exposed_as);
+      }
+      const fields = [];
+      for (const pf of projectionType.fields) {
+        const field = columns.get(pf.column_name);
+        if (field === void 0) continue;
+        const reason = deprecationFor(pf, currentLabels, currentVersion);
+        fields.push({
+          field,
+          exposedAs: pf.exposed_as,
+          required: pf.required,
+          ...pf.fallback !== void 0 && { fallback: pf.fallback },
+          ...reason !== void 0 && { deprecationReason: reason }
+        });
+      }
+      for (const f of type.fields) {
+        if (isColumnBacked(f) || f.removed === true) continue;
+        fields.push({ field: f, exposedAs: f.name, required: f.required });
+      }
+      out[typeName] = { fields };
+    }
+  }
+  return out;
+}
+
 // src/graphql/dataloaders.ts
 var import_dataloader = __toESM(require("dataloader"));
 
@@ -579,9 +668,8 @@ function groupBy(items, key) {
   }
   return result;
 }
-function needsFkResolution(row, fkColumn, fieldName) {
-  if (fkColumn !== fieldName && !(fkColumn in row)) return false;
-  const current = row[fieldName];
+function needsFkResolution(row, fkColumn) {
+  const current = row[fkColumn];
   return !(typeof current === "object" && current !== null);
 }
 async function resolveRelationField(db, rows, fieldName, rel, cache, publishedOnly = false) {
@@ -598,15 +686,11 @@ async function resolveRelationField(db, rows, fieldName, rel, cache, publishedOn
       row[fieldName] = byParent[row["id"]] ?? [];
     }
   } else if (rel.type === "reference") {
-    const dropFk = rel.fk_column !== fieldName;
-    const pending = batch.filter((r) => needsFkResolution(r, rel.fk_column, fieldName));
+    const pending = batch.filter((r) => needsFkResolution(r, rel.fk_column));
     if (pending.length === 0) return;
     const fkValues = pending.map((r) => r[rel.fk_column]).filter(Boolean);
     if (fkValues.length === 0) {
-      for (const row of pending) {
-        row[fieldName] = null;
-        if (dropFk) delete row[rel.fk_column];
-      }
+      for (const row of pending) row[rel.fk_column] = null;
       return;
     }
     const unique = [...new Set(fkValues)];
@@ -623,8 +707,7 @@ async function resolveRelationField(db, rows, fieldName, rel, cache, publishedOn
     }
     for (const row of pending) {
       const fkVal = row[rel.fk_column];
-      row[fieldName] = fkVal ? cache.get(`${rel.table}:${fkVal}`) ?? null : null;
-      if (dropFk) delete row[rel.fk_column];
+      row[rel.fk_column] = fkVal ? cache.get(`${rel.table}:${fkVal}`) ?? null : null;
     }
   } else if (rel.type === "junction") {
     const parentIds = batch.map((r) => r["id"]);
@@ -652,15 +735,11 @@ async function resolveRelationField(db, rows, fieldName, rel, cache, publishedOn
       row[fieldName] = jEntries.map((jr) => cache.get(`${rel.table}:${jr[rel.right_column]}`)).filter(Boolean);
     }
   } else if (rel.type === "media") {
-    const dropFk = rel.fk_column !== fieldName;
-    const pending = batch.filter((r) => needsFkResolution(r, rel.fk_column, fieldName));
+    const pending = batch.filter((r) => needsFkResolution(r, rel.fk_column));
     if (pending.length === 0) return;
     const fkValues = pending.map((r) => r[rel.fk_column]).filter(Boolean);
     if (fkValues.length === 0) {
-      for (const row of pending) {
-        row[fieldName] = null;
-        if (dropFk) delete row[rel.fk_column];
-      }
+      for (const row of pending) row[rel.fk_column] = null;
       return;
     }
     const unique = [...new Set(fkValues)];
@@ -674,8 +753,7 @@ async function resolveRelationField(db, rows, fieldName, rel, cache, publishedOn
     }
     for (const row of pending) {
       const fkVal = row[rel.fk_column];
-      row[fieldName] = fkVal ? cache.get(`media:${fkVal}`) ?? null : null;
-      if (dropFk) delete row[rel.fk_column];
+      row[rel.fk_column] = fkVal ? cache.get(`media:${fkVal}`) ?? null : null;
     }
   }
 }
@@ -702,7 +780,8 @@ function createRelationLoaders(db, registry) {
         async (parents) => {
           const rows = parents;
           await resolveRelationField(db, rows, fieldName, rel, cache, true);
-          return rows.map((r) => r[fieldName]);
+          const resultKey = rel.type === "reference" || rel.type === "media" ? rel.fk_column : fieldName;
+          return rows.map((r) => r[resultKey]);
         },
         // Batch within a tick; do not memoize by parent identity (rows are mutated
         // and may recur across nesting levels).
@@ -754,15 +833,29 @@ function isClientSafeGraphQLError(error) {
   }
   return false;
 }
-function createGraphQLHandler(registry, repos, fieldKeyMaps, resolver, db, options) {
-  const schema = buildGraphQLSchema(registry, fieldKeyMaps);
+function createGraphQLHandler(registry, repos, fieldKeyMaps, resolver, db, options, versioning = {}) {
+  let view;
+  if (versioning.projection !== void 0) {
+    if (versioning.currentVersion === void 0) {
+      throw new Error(
+        'createGraphQLHandler: currentVersion is required when a projection is supplied \u2014 deprecation reasons name it, and an empty one ships "Removed in ." into published SDL.'
+      );
+    }
+    view = buildVersionView({
+      registry,
+      projection: versioning.projection,
+      currentProjection: versioning.currentProjection,
+      currentVersion: versioning.currentVersion
+    });
+  }
+  const schema = buildGraphQLSchema(registry, fieldKeyMaps, view, versioning.currentFieldKeyMaps ?? fieldKeyMaps);
   const { plugins } = buildArmorPlugin({
     maxDepth: options.maxDepth,
     maxComplexity: options.maxComplexity
   });
   const yoga = (0, import_graphql_yoga.createYoga)({
     schema,
-    graphqlEndpoint: "/graphql",
+    graphqlEndpoint: versioning.endpoint ?? "/graphql",
     graphiql: options.graphiql,
     landingPage: false,
     maskedErrors: {