@bobbykim/manguito-cms-api 0.5.0 → 0.6.0

package/dist/index.js

@@ -45,7 +45,8 @@ function buildFieldKeyMap(pairs, allLabels, droppedKeys) {
     labelToColumn.set(label, column);
     columnToLabel.set(column, label);
   }
-  for (const label of allLabels) {
+  for (const { label, ownColumn } of allLabels) {
+    if (ownColumn === label) continue;
     const columnOwner = columnToLabel.get(label);
     if (columnOwner !== void 0 && columnOwner !== label) {
       throw new Error(
@@ -90,7 +91,12 @@ function createFieldKeyMap(fields) {
   }
   return buildFieldKeyMap(
     pairs,
-    fields.map((f) => f.name),
+    fields.map((f) => ({
+      label: f.name,
+      // Conditional spread, not a plain assignment — exactOptionalPropertyTypes
+      // forbids present-and-undefined.
+      ...isColumnBacked(f) && { ownColumn: f.db_column.column_name }
+    })),
     droppedKeys
   );
 }
@@ -107,7 +113,13 @@ function createFieldKeyMapFromProjection(projectionType, allFields) {
   for (const label of projected) dropped.delete(label);
   return buildFieldKeyMap(
     pairs,
-    allFields.map((f) => f.name),
+    allFields.map((f) => ({
+      label: f.name,
+      // See buildFieldKeyMap's collision check: this is what lets it tell a
+      // version exposing a field's own column under a new label (fine) from a
+      // label that reuses another field's column (not fine).
+      ...isColumnBacked(f) && { ownColumn: f.db_column.column_name }
+    })),
     dropped
   );
 }
@@ -537,10 +549,13 @@ var init_naming = __esm({
 });
 
 // src/graphql/filters.ts
-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) {
@@ -575,18 +590,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 });
@@ -649,32 +665,41 @@ function codeError2(code, message) {
 function isPublished2(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);
 }
-function programmaticFieldResolver(typeName, schemaFieldName, mediaFieldNames = [], fieldKeys) {
+function programmaticFieldResolver(typeName, schemaFieldName, mediaFields = [], fieldKeys) {
   return async (parent, _args, ctx) => {
     let p = ctx.programmaticMemo.get(parent);
     if (!p) {
-      p = resolveProgrammaticRow(typeName, parent, ctx, mediaFieldNames, fieldKeys);
+      p = resolveProgrammaticRow(typeName, parent, ctx, mediaFields, fieldKeys);
       ctx.programmaticMemo.set(parent, p);
     }
     return (await p)[schemaFieldName];
   };
 }
-async function resolveProgrammaticRow(typeName, parent, ctx, mediaFieldNames, fieldKeys) {
+async function resolveProgrammaticRow(typeName, parent, ctx, mediaFields, fieldKeys) {
   const toLabels = (row) => fieldKeys ? fieldKeys.toLabels(row) : row;
-  if (mediaFieldNames.length === 0) return ctx.resolver.resolveItem(typeName, toLabels(parent));
+  if (mediaFields.length === 0) return ctx.resolver.resolveItem(typeName, toLabels(parent));
   const enriched = { ...parent };
-  await Promise.all(mediaFieldNames.map((name) => ctx.loaders.load(typeName, name, enriched)));
-  return ctx.resolver.resolveItem(typeName, toLabels(enriched));
+  await Promise.all(mediaFields.map((m) => ctx.loaders.load(typeName, m.name, enriched)));
+  return ctx.resolver.resolveItem(typeName, relabelMedia(toLabels(enriched), enriched, mediaFields));
+}
+function relabelMedia(record, enriched, mediaFields) {
+  for (const { name, exposedAs } of mediaFields) {
+    if (!(name in enriched)) continue;
+    record[exposedAs] = enriched[name];
+  }
+  return record;
 }
 function collectionResolver(typeName, nameMap, fieldKeys) {
   return async (_root, args, ctx) => {
@@ -732,7 +757,7 @@ var init_resolvers = __esm({
 });
 
 // src/graphql/schema.ts
-function buildGraphQLSchema(registry, fieldKeyMaps = {}) {
+function buildGraphQLSchema(registry, fieldKeyMaps = {}, view) {
   const objectTypes = /* @__PURE__ */ new Map();
   const enumTypes = /* @__PURE__ */ new Map();
   for (const [name, enumType] of Object.entries(registry.enum_types)) {
@@ -751,14 +776,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;
@@ -788,8 +813,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 mediaFields = visible.filter(
+      (v) => v.field.field_type === "image" || v.field.field_type === "video" || v.field.field_type === "file"
+    ).map((v) => ({ name: v.field.name, exposedAs: v.exposedAs }));
     return new import_graphql5.GraphQLObjectType({
       name: graphqlTypeName(machineName),
       fields: () => {
@@ -803,23 +837,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, mediaFields, fieldKeyMaps[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;
       }
@@ -851,7 +887,8 @@ 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));
     if (ct.only_one) {
       queryFields[singleQueryName(name)] = { type: objType, resolve: singletonResolver(name) };
       continue;
@@ -863,13 +900,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 } } : {}
       },
@@ -893,7 +930,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,
@@ -943,6 +984,76 @@ var init_schema = __esm({
   }
 });
 
+// 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;
+}
+var init_version_view = __esm({
+  "src/graphql/version-view.ts"() {
+    "use strict";
+    init_field_keys();
+  }
+});
+
 // src/graphql/dataloaders.ts
 function createRelationLoaders(db, registry) {
   const relMaps = /* @__PURE__ */ new Map();
@@ -1035,15 +1146,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);
   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: {
@@ -1071,6 +1196,7 @@ var init_handler = __esm({
     "use strict";
     import_graphql_yoga = require("graphql-yoga");
     init_schema();
+    init_version_view();
     init_dataloaders();
     init_security();
   }
@@ -1180,7 +1306,7 @@ function createSecurityHeadersMiddleware(options = {}) {
     c.res.headers.set("X-Content-Type-Options", "nosniff");
     c.res.headers.set("X-Frame-Options", "DENY");
     c.res.headers.set("Referrer-Policy", "no-referrer");
-    const isGraphiql = graphiqlPath !== void 0 && c.req.path === graphiqlPath;
+    const isGraphiql = graphiqlPath !== void 0 && (c.req.path === graphiqlPath || c.req.path.startsWith(`${graphiqlPath}/`));
     c.res.headers.set("Content-Security-Policy", isGraphiql ? graphiqlCsp : csp);
   };
 }
@@ -3816,7 +3942,7 @@ function registerUserRoutes(app, db, requirePermission, requireHierarchy) {
 var import_drizzle_orm6 = require("drizzle-orm");
 var API_VERSION = (() => {
   try {
-    return "0.5.0";
+    return "0.6.0";
   } catch {
     return "0.0.0";
   }
@@ -4414,20 +4540,6 @@ function createCmsApp(options) {
       sortableColumns
     });
   };
-  const graphqlRepos = Object.fromEntries([
-    ...Object.entries(registry.content_types).map(([typeName, ct]) => [
-      typeName,
-      createDrizzleContentRepository(db, ct.db.table_name, {
-        sortableColumns: sortableColumnsFor(typeName)
-      })
-    ]),
-    ...Object.entries(registry.taxonomy_types).map(([typeName, tt]) => [
-      typeName,
-      createDrizzleContentRepository(db, tt.db.table_name, {
-        sortableColumns: sortableColumnsFor(typeName)
-      })
-    ])
-  ]);
   registerAuthRoutes(app, db);
   app.use("/admin/api/*", authMiddleware);
   app.use("/admin/api/*", mustChangePasswordCheck);
@@ -4525,31 +4637,107 @@ function createCmsApp(options) {
   registerPublicMediaRoutes(app, mediaRepo, publicPaths, listRateLimit);
   if (options.graphql?.enabled) {
     const gqlOptions = options.graphql;
-    let gqlHandler = null;
-    let initError = null;
+    const makeGraphqlRepo = (_typeName, tableName, sortableColumns) => createDrizzleContentRepository(db, tableName, { sortableColumns });
+    const gqlPasses = [
+      ...options.versions !== void 0 ? model.live.map((v) => ({ version: v, projectionVersion: v })) : [],
+      { version: null, projectionVersion: model.current }
+    ];
+    const mounts = gqlPasses.map((pass) => ({
+      path: pass.version === null ? "/graphql" : `/graphql/${pass.version}`,
+      version: pass.version,
+      handler: null,
+      error: null
+    }));
     const ready = Promise.resolve().then(() => (init_handler(), handler_exports)).then(({ createGraphQLHandler: createGraphQLHandler2 }) => {
-      gqlHandler = createGraphQLHandler2(registry, graphqlRepos, fieldKeyMaps, programmaticResolver, db, gqlOptions);
+      gqlPasses.forEach((pass, i) => {
+        const mount = mounts[i];
+        try {
+          const surface = buildVersionSurface({
+            ...pass,
+            prefix,
+            registry,
+            model,
+            makeRepo: makeGraphqlRepo
+          });
+          const projection = model.projections[pass.projectionVersion];
+          const currentProjection = model.projections[model.current];
+          mount.handler = createGraphQLHandler2(
+            registry,
+            surface.repos,
+            surface.fieldKeyMaps,
+            programmaticResolver,
+            db,
+            gqlOptions,
+            {
+              endpoint: mount.path,
+              currentVersion: model.current,
+              ...projection !== void 0 && { projection },
+              ...currentProjection !== void 0 && { currentProjection }
+            }
+          );
+        } catch (err) {
+          mount.error = err;
+          const message = err instanceof Error ? err.message : String(err);
+          process.stderr.write(
+            `\u2717 GraphQL schema failed to initialize for ${mount.path}; it will return 500. ${message}
+`
+          );
+        }
+      });
     }).catch((err) => {
-      initError = err;
+      for (const m of mounts) m.error = err;
       const message = err instanceof Error ? err.message : String(err);
-      process.stderr.write(`\u2717 GraphQL schema failed to initialize; /graphql will return 500. ${message}
+      const paths = mounts.map((m) => m.path).join(", ");
+      process.stderr.write(`\u2717 GraphQL module failed to load; ${paths} will return 500. ${message}
 `);
     });
-    const invokeGraphQL = async (c) => {
-      if (!gqlHandler && !initError) await ready;
-      if (!gqlHandler) {
+    const invokeFor = (mount) => async (c) => {
+      if (!mount.handler && !mount.error) await ready;
+      if (!mount.handler) {
         return c.json(
           { ok: false, error: { code: "GRAPHQL_INIT_FAILED", message: "GraphQL schema failed to initialize" } },
           500
         );
       }
-      return gqlHandler(c, async () => {
+      return mount.handler(c, async () => {
       });
     };
-    if (listRateLimit) {
-      app.all("/graphql", listRateLimit, invokeGraphQL);
-    } else {
-      app.all("/graphql", invokeGraphQL);
+    for (const mount of mounts) {
+      const headers = deprecationHeaders({
+        requested: mount.version,
+        model,
+        successor: `/graphql/${model.current}`
+      });
+      if (headers === null) continue;
+      const attach = async (c, next) => {
+        await next();
+        for (const [key, value] of Object.entries(headers)) c.res.headers.set(key, value);
+      };
+      app.use(mount.path, attach);
+    }
+    for (const mount of mounts) {
+      if (listRateLimit) app.all(mount.path, listRateLimit, invokeFor(mount));
+      else app.all(mount.path, invokeFor(mount));
+    }
+    if (options.versions !== void 0) {
+      app.all("/graphql/:version", async (c, next) => {
+        const segment = c.req.param("version");
+        const kind = classifyVersion(segment, model);
+        if (kind === "not-a-version" || kind === "live") return next();
+        const live = model.live.join(", ");
+        return c.json({
+          errors: [
+            {
+              message: kind === "retired" ? `Version ${segment} is no longer served. Live versions: ${live}.` : `Version ${segment} does not exist. Live versions: ${live}.`,
+              extensions: {
+                code: kind === "retired" ? "VERSION_RETIRED" : "VERSION_UNKNOWN",
+                current: model.current,
+                live: model.live
+              }
+            }
+          ]
+        });
+      });
     }
   }
   registerConfigRoute(