@remkoj/optimizely-graph-functions 4.0.0 → 4.2.0

package/README.md

@@ -1,13 +1,19 @@
 # Optimizely GraphQL Codegen Plugin
 GraphQL Codegen plugin and preset which generate both the GraphQL type definitions and a few convenienece methods for useage with [Optimizely Graph Client](../optimizely-graph-client/README.md).
 
+> [!WARNING]
+> **Version 4.1** Requires a new build of the patched Visitor Plugin Common package from GraphQL Codegen. See instructions below on updating/installing this patched version.
+
 ## Install package
 To install using Yarn, use the following command:
 
 ```bash
 yarn add --dev @remkoj/optimizely-graph-functions
+yarn patch-codegen
 ```
 
+Some updates will include a newer version of the patched Visitor Plugin Common package from GraphQL Codegen. After applying the update to this package, rerun `yarn patch-codegen` to download and apply the latest version.
+
 ## Configure package
 Create a codegen.ts within your application root folder (e.g. apps/frontend/codegen.ts within the example site). Within the codegen.ts create the following configuration:
 
@@ -87,7 +93,7 @@ The presetConfig of the `OptimizelyGraphPreset` is an extension of the configura
 
 | Configuration option | Usage |
 | --- | --- |
-| recursion | Set to `true` to automatically generate recursive queries to iterate down the result.<br><br>The default logic of GraphQL Codegen contains an infite loop when disabling the recursion check. To patch this, a custom resolution must be added to the root `package.json`. This resolution must set the resolution for `@graphql-codegen/visitor-plugin-common` to the patched file [provided within this repository](../../dependencies/graphql-codegen-visitor-plugin-common-v5.3.1-patched.tgz) |
+| recursion | Set to `true` to automatically generate recursive queries to iterate down the result.<br><br>The default logic of GraphQL Codegen contains an infite loop when disabling the recursion check. To patch this, a custom resolution must be added to the root `package.json`. This resolution must set the resolution for `@graphql-codegen/visitor-plugin-common` to the patched file [provided within this repository](../../dependencies/graphql-codegen-visitor-plugin-common-v5.6.0-patched.tgz)<br/><br/>A Convenience script: `yarn patch-codegen` is available to apply these transformations automatically |
 | injections | A set of rules to define how individual fragments will be used to construct the master queries. Each rule has the following options: <br/>- `into`:  The name of the Fragment to inject into<br/>- `pathRegex`: The regular expression to be applied ot the file name to see if the fragment should be included with the `into` Fragment<br/>- `nameRegex`: The regular expression to be applied to the name of the Fragment
 | documents | The standard rules for preset specific documents, however there are four standard documents available:<br/>- `opti-cms:/queries/13` (included by default)<br/>- `opti-cms:/queries/12`<br/>- `opti-cms:/fragments/13` (included by default)<br/>- `opti-cms:/fragments/12`<br/>*The defaults are only applied when there's no document starting with `opti-cms:` defined*
 | functions | The list of GraphQL Functions that should be made available in the `functions.ts` file. When specified, this overrides the default list.<br/>*Default value: `['getContentType','getContentByPath','getContentById']`*

package/dist/patch.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/patch.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const posix_1 = __importDefault(require("node:path/posix"));
+const node_stream_1 = require("node:stream");
+const promises_1 = require("node:stream/promises");
+const downloadLink = "https://github.com/remkoj/optimizely-dxp-clients/raw/refs/heads/main/dependencies/graphql-codegen-visitor-plugin-common-v5.6.0-patched.tgz";
+const downloadFile = "graphql-codegen-visitor-plugin-common-v5.6.0-patched.tgz";
+const downloadPath = "./packages";
+const packageJsonPath = node_path_1.default.join(process.cwd(), 'package.json');
+if (!node_fs_1.default.existsSync(packageJsonPath)) {
+    process.exit(0);
+}
+const packageData = JSON.parse(node_fs_1.default.readFileSync(packageJsonPath).toString());
+const packageName = packageData.name ?? node_path_1.default.basename(process.cwd());
+console.log("🚀 [Optimizely Graph Functions] Enabling recursive query support for project: " + packageName);
+const downloadDir = node_path_1.default.normalize(node_path_1.default.join(process.cwd(), downloadPath));
+fetch(downloadLink).then(response => {
+    if (!response.ok || !response.body)
+        return;
+    node_fs_1.default.mkdirSync(downloadDir, { recursive: true });
+    const downloadTarget = node_path_1.default.join(downloadDir, downloadFile);
+    console.log("🚀 [Optimizely Graph Functions] Downloading patched visitor-plugin-common from GitHub");
+    (0, promises_1.finished)(node_stream_1.Readable.fromWeb(response.body).pipe(node_fs_1.default.createWriteStream(downloadTarget, { flags: 'w' }))).then(() => {
+        console.log("🚀 [Optimizely Graph Functions] Downloaded patched visitor-plugin-common");
+        packageData.resolutions = packageData.resolutions || {};
+        const importPath = 'file:./' + posix_1.default.normalize(posix_1.default.join(downloadPath, downloadFile));
+        if (packageData.resolutions["@graphql-codegen/visitor-plugin-common"] != importPath) {
+            packageData.resolutions["@graphql-codegen/visitor-plugin-common"] = importPath;
+            const updatedPackageData = JSON.stringify(packageData, undefined, 2);
+            node_fs_1.default.writeFileSync(packageJsonPath, updatedPackageData, { flag: 'w' });
+            console.log("🚀 [Optimizely Graph Functions] Applied resolution to project " + packageName);
+        }
+        else {
+            console.log("🚀 [Optimizely Graph Functions] Resolution already exists " + packageName);
+        }
+    });
+});
+//# sourceMappingURL=patch.js.map

package/dist/patch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.js","sourceRoot":"","sources":["../src/patch.ts"],"names":[],"mappings":";;;;;AAAA,sDAAwB;AACxB,0DAA4B;AAC5B,4DAAmC;AACnC,6CAAsC;AACtC,mDAA+C;AAE/C,MAAM,YAAY,GAAG,4IAA4I,CAAA;AACjK,MAAM,YAAY,GAAG,0DAA0D,CAAA;AAC/E,MAAM,YAAY,GAAG,YAAY,CAAA;AAEjC,MAAM,eAAe,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAA;AAChE,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EACnC,CAAC;IACG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACnB,CAAC;AAED,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;AAC3E,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,IAAI,mBAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;AAEpE,OAAO,CAAC,GAAG,CAAC,gFAAgF,GAAC,WAAW,CAAC,CAAA;AAEzG,MAAM,WAAW,GAAG,mBAAI,CAAC,SAAS,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC,CAAA;AAC1E,KAAK,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;IAChC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;QAC9B,OAAM;IAEV,iBAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC9C,MAAM,cAAc,GAAG,mBAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;IAE3D,OAAO,CAAC,GAAG,CAAC,uFAAuF,CAAC,CAAA;IACpG,IAAA,mBAAQ,EAAC,sBAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAiD,CAAC,CAAC,IAAI,CAAC,iBAAE,CAAC,iBAAiB,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACxJ,OAAO,CAAC,GAAG,CAAC,0EAA0E,CAAC,CAAA;QAEvF,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC,WAAW,IAAI,EAAE,CAAA;QACvD,MAAM,UAAU,GAAG,SAAS,GAAG,eAAK,CAAC,SAAS,CAAC,eAAK,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAA;QACtF,IAAI,WAAW,CAAC,WAAW,CAAC,wCAAwC,CAAC,IAAI,UAAU,EAAE,CAAC;YAClF,WAAW,CAAC,WAAW,CAAC,wCAAwC,CAAC,GAAG,UAAU,CAAA;YAC9E,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,CAAA;YACpE,iBAAE,CAAC,aAAa,CAAC,eAAe,EAAE,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAA;YACpE,OAAO,CAAC,GAAG,CAAC,gEAAgE,GAAC,WAAW,CAAC,CAAA;QAC7F,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,GAAG,CAAC,4DAA4D,GAAC,WAAW,CAAC,CAAA;QACzF,CAAC;IACL,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@remkoj/optimizely-graph-functions",
   "license": "Apache-2.0",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "repository": "https://github.com/remkoj/optimizely-dxp-clients.git",
   "author": "Remko Jantzen <693172+remkoj@users.noreply.github.com>",
   "homepage": "https://github.com/remkoj/optimizely-dxp-clients",
   "files": [
     "./dist"
   ],
+  "bin": {
+    "patch-codegen": "./dist/patch.js"
+  },
   "type": "commonjs",
   "main": "./dist/index.js",
   "exports": {
@@ -38,11 +41,11 @@
     }
   },
   "devDependencies": {
-    "@types/node": "^22.10.1",
-    "graphql": "^16.9.0",
+    "@types/node": "^22.10.7",
+    "graphql": "^16.10.0",
     "graphql-request": "^6.1.0",
     "graphql-tag": "^2.12.6",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   },
   "dependencies": {
     "@graphql-codegen/add": "^5.0.3",
@@ -57,13 +60,14 @@
     "clean": "tsc --build --clean",
     "prepare": "tsc --build",
     "recompile": "tsc --build --clean && tsc --build --force",
-    "watch": "yarn tsc --watch"
+    "watch": "yarn tsc --watch",
+    "test-patch": "node ./dist/patch.js"
   },
   "peerDependencies": {
-    "@graphql-typed-document-node/core": "*",
-    "@remkoj/optimizely-graph-client": "4.0.0",
-    "graphql": "*",
-    "graphql-request": "^6.1.0",
-    "graphql-tag": "*"
+    "@graphql-typed-document-node/core": "^3",
+    "@remkoj/optimizely-graph-client": "^4",
+    "graphql": "^16",
+    "graphql-request": "^6",
+    "graphql-tag": "^2"
   }
 }