@preprio/toolkit 0.4.3 → 0.5.0-rc.10

package/dist/codegen/index.d.cts

@@ -0,0 +1,70 @@
+import { DocumentNode, GraphQLSchema } from 'graphql';
+
+/**
+ * The slice of a GraphQL Codegen `DocumentFile` this transform touches,
+ * written out so the package needs no dependency on `@graphql-codegen/*`.
+ */
+interface CodegenDocumentFile {
+    document?: DocumentNode;
+}
+interface PreprIdsOptions {
+    /**
+     * Also select `__typename` on every object, interface and union below the
+     * root. Default `false`: a selected `__typename` changes the types Codegen
+     * generates (each union member is typed separately, and objects built by
+     * hand must carry one), which can break code that compiles today. Live
+     * preview only needs it on dynamic content entries, where you select it
+     * already to render them.
+     */
+    typename?: boolean;
+}
+/**
+ * Select `_id` on every level of a query that has one, so live preview and
+ * click-to-edit can find each item without you selecting it by hand.
+ *
+ * The schema decides where it goes: only on types that have an `_id`
+ * (models and components, not collections like `Pages` or unions; inside a
+ * union, on each member). Adding a field never breaks the types Codegen
+ * generates. With `typename: true`, `__typename` is added on every object,
+ * interface and union below the root too. Fields already selected are left
+ * as they are.
+ */
+declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema, options?: PreprIdsOptions): DocumentNode;
+/** A GraphQL Codegen document transform. */
+interface CodegenDocumentTransform {
+    transform<File extends CodegenDocumentFile>(options: {
+        documents: File[];
+        schema: DocumentNode;
+    }): File[];
+}
+/**
+ * GraphQL Codegen document transform that runs `addPreprIds` on every
+ * document, with options:
+ *
+ * ```ts
+ * documentTransforms: [createPreprIds({ typename: true })],
+ * ```
+ */
+declare function createPreprIds(options?: PreprIdsOptions): CodegenDocumentTransform;
+/**
+ * GraphQL Codegen document transform that runs `addPreprIds` on every
+ * document, so the generated documents and types include `_id` wherever the
+ * schema has one:
+ *
+ * ```ts
+ * // codegen.ts
+ * import { preprIds } from '@preprio/toolkit/codegen';
+ *
+ * generates: {
+ *   'src/gql/': {
+ *     preset: 'client',
+ *     documentTransforms: [preprIds],
+ *   },
+ * },
+ * ```
+ *
+ * `createPreprIds({ typename: true })` adds `__typename` as well.
+ */
+declare const preprIds: CodegenDocumentTransform;
+
+export { type CodegenDocumentFile, type CodegenDocumentTransform, type PreprIdsOptions, addPreprIds, createPreprIds, preprIds };

package/dist/codegen/index.d.ts

@@ -0,0 +1,70 @@
+import { DocumentNode, GraphQLSchema } from 'graphql';
+
+/**
+ * The slice of a GraphQL Codegen `DocumentFile` this transform touches,
+ * written out so the package needs no dependency on `@graphql-codegen/*`.
+ */
+interface CodegenDocumentFile {
+    document?: DocumentNode;
+}
+interface PreprIdsOptions {
+    /**
+     * Also select `__typename` on every object, interface and union below the
+     * root. Default `false`: a selected `__typename` changes the types Codegen
+     * generates (each union member is typed separately, and objects built by
+     * hand must carry one), which can break code that compiles today. Live
+     * preview only needs it on dynamic content entries, where you select it
+     * already to render them.
+     */
+    typename?: boolean;
+}
+/**
+ * Select `_id` on every level of a query that has one, so live preview and
+ * click-to-edit can find each item without you selecting it by hand.
+ *
+ * The schema decides where it goes: only on types that have an `_id`
+ * (models and components, not collections like `Pages` or unions; inside a
+ * union, on each member). Adding a field never breaks the types Codegen
+ * generates. With `typename: true`, `__typename` is added on every object,
+ * interface and union below the root too. Fields already selected are left
+ * as they are.
+ */
+declare function addPreprIds(document: DocumentNode, schema: GraphQLSchema, options?: PreprIdsOptions): DocumentNode;
+/** A GraphQL Codegen document transform. */
+interface CodegenDocumentTransform {
+    transform<File extends CodegenDocumentFile>(options: {
+        documents: File[];
+        schema: DocumentNode;
+    }): File[];
+}
+/**
+ * GraphQL Codegen document transform that runs `addPreprIds` on every
+ * document, with options:
+ *
+ * ```ts
+ * documentTransforms: [createPreprIds({ typename: true })],
+ * ```
+ */
+declare function createPreprIds(options?: PreprIdsOptions): CodegenDocumentTransform;
+/**
+ * GraphQL Codegen document transform that runs `addPreprIds` on every
+ * document, so the generated documents and types include `_id` wherever the
+ * schema has one:
+ *
+ * ```ts
+ * // codegen.ts
+ * import { preprIds } from '@preprio/toolkit/codegen';
+ *
+ * generates: {
+ *   'src/gql/': {
+ *     preset: 'client',
+ *     documentTransforms: [preprIds],
+ *   },
+ * },
+ * ```
+ *
+ * `createPreprIds({ typename: true })` adds `__typename` as well.
+ */
+declare const preprIds: CodegenDocumentTransform;
+
+export { type CodegenDocumentFile, type CodegenDocumentTransform, type PreprIdsOptions, addPreprIds, createPreprIds, preprIds };

package/dist/codegen/index.js

@@ -0,0 +1,64 @@
+// src/codegen/index.ts
+import {
+  buildASTSchema,
+  isCompositeType,
+  isInterfaceType,
+  isObjectType,
+  Kind,
+  TypeInfo,
+  visit,
+  visitWithTypeInfo
+} from "graphql";
+function field(name) {
+  return { kind: Kind.FIELD, name: { kind: Kind.NAME, value: name } };
+}
+function hasResponseKey(set, key) {
+  return set.selections.some(
+    (s) => s.kind === Kind.FIELD && (s.alias ?? s.name).value === key
+  );
+}
+function addPreprIds(document, schema, options = {}) {
+  const typename = options.typename ?? false;
+  const roots = new Set(
+    [
+      schema.getQueryType(),
+      schema.getMutationType(),
+      schema.getSubscriptionType()
+    ].filter(Boolean)
+  );
+  const typeInfo = new TypeInfo(schema);
+  return visit(
+    document,
+    visitWithTypeInfo(typeInfo, {
+      SelectionSet(node) {
+        const type = typeInfo.getParentType();
+        if (!type || !isCompositeType(type) || roots.has(type)) return;
+        const added = [];
+        if ((isObjectType(type) || isInterfaceType(type)) && "_id" in type.getFields() && !hasResponseKey(node, "_id")) {
+          added.push(field("_id"));
+        }
+        if (typename && !hasResponseKey(node, "__typename")) {
+          added.push(field("__typename"));
+        }
+        if (!added.length) return;
+        return { ...node, selections: [...added, ...node.selections] };
+      }
+    })
+  );
+}
+function createPreprIds(options = {}) {
+  return {
+    transform({ documents, schema }) {
+      const built = buildASTSchema(schema, { assumeValidSDL: true });
+      return documents.map(
+        (file) => file.document ? { ...file, document: addPreprIds(file.document, built, options) } : file
+      );
+    }
+  };
+}
+var preprIds = createPreprIds();
+export {
+  addPreprIds,
+  createPreprIds,
+  preprIds
+};