@okam/directus-node 0.0.1 → 0.1.0

package/.eslintrc.js

@@ -0,0 +1,21 @@
+const { getDefaultIgnorePatterns } = require("../../../linter/helpers");
+
+module.exports = {
+  extends: ['plugin:@nx/react', '../../../.eslintrc.js', '../../../linter/bases/typescript', '../../../linter/bases/regexp', '../../../linter/bases/jest', '../../../linter/bases/rtl', '../../../linter/bases/storybook', '../../../linter/bases/react', '../../../linter/bases/prettier', 'plugin:storybook/recommended'],
+  ignorePatterns: ['!**/*', ...getDefaultIgnorePatterns()],
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx', '*.js', '*.jsx'],
+      // We set parserOptions.project for the project to allow TypeScript to create the type-checker behind the scenes when we run linting
+      parserOptions: {
+        project: `${__dirname}/tsconfig.*?.json`,
+      },
+      rules: {
+        "@nx/dependency-checks": "error"
+      }
+    },
+  ],
+  rules: {
+    'react/react-in-jsx-scope': 'off',
+  },
+}

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.1.0 (2024-06-28)
+
+
+### 🚀 Features
+
+- add gql query ([#73](https://github.com/OKAMca/stack/pull/73))
+
+
+### ❤️  Thank You
+
+- Marie-Maxime Tanguay @marie-maxime

package/README.md

@@ -21,14 +21,28 @@ Run `nx test directus-node` to execute the unit tests via [Jest](https://jestjs.
  * npx env-cmd -f ../../.env.local node fetch-redirect.js
  */
 const { fetchRedirects, getDefaultConfig } = require('@okam/directus-node')
+
 fetchRedirects(getDefaultConfig())
 ```
 
-2. In project.json targets.build, add "dependsOn": ["fetch-redirect"]
+2. In project.json,
+ 1. In targets.build, add `"dependsOn": ["fetch-redirect"],`
+ 2. In targets:
+```
+    "fetch-redirect": {
+      "executor": "nx:run-commands",
+      "options": {
+        "cwd": "{projectRoot}",
+        "command": "node fetch-redirect"
+      }
+    },
+```
+ 3. Don't forget to change the cwd path
 
-3. Create directory redirection
 
-4. Create file redirection/index.js
+3. Create directory redirect
+
+4. Create file redirect/index.js
 ```
 const redirects = require('./redirects.json')
 const rewrites = require('./rewrites.json')
@@ -46,7 +60,38 @@ NEXT_PUBLIC_GRAPHQL_URL=
 NEXT_API_TOKEN_ADMIN=
 ```
 
-6. Generate redirects.json and rewrites.json using fetch-redirect (or build project with nx)
+6. Generate redirect/redirects.json and redirect/rewrites.json using fetch-redirect (or build project with nx)
 ```
 npx env-cmd -f ../../.env.local node fetch-redirect.js
 ```
+
+7. Update nextConfig in next.config.js with
+```
+const { rewrites, redirects } = require('./redirect/index')
+```
+```
+const nextConfig = {
+...
+  async redirects() {
+    const rest = await redirects()
+    return [
+       ...i18nReRouter({locale: false, permanent: true}, 'redirect'),
+       ...rest,
+    ]
+    return rest
+  },
+  async rewrites() {
+    const fallback = await rewrites()
+    return {
+      beforeFiles: [
+        ...i18nReRouter({locale: false}, 'rewrite'),
+      ],
+      afterFiles: [
+        ...i18nRewriter({...i18nConfigWithoutLocaleDetector, localeDetector: false}),
+      ],
+      fallback,
+    }
+  },
+...
+}
+```

package/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'directus-node',
+  preset: '../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../coverage/libs/directus/directus-node',
+}

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@okam/directus-node",
-  "main": "./src/index.js",
-  "version": "0.0.1",
+  "main": "./index.js",
+  "version": "0.1.0",
   "types": "./index.d.ts",
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
   "repository": {
     "url": "https://github.com/OKAMca/stack.git"
-  },
-  "type": "commonjs"
+  }
 }

package/project.json

@@ -0,0 +1,34 @@
+{
+  "name": "directus-node",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/directus/directus-node/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/directus/directus-node",
+        "tsConfig": "libs/directus/directus-node/tsconfig.lib.json",
+        "packageJson": "libs/directus/directus-node/package.json",
+        "main": "libs/directus/directus-node/src/index.ts",
+        "assets": ["libs/directus/directus-node/*.md"]
+      }
+    },
+    "publish": {
+      "command": "node tools/scripts/publish.mjs directus-node {args.ver} {args.tag}",
+      "dependsOn": ["build"]
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/directus/directus-node/jest.config.ts"
+      }
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './lib/redirection'
+export { default as graphqlCodegenConfig } from './lib/codegen'

package/src/lib/codegen.ts

@@ -0,0 +1,25 @@
+import type { CodegenConfig } from '@graphql-codegen/cli'
+
+const graphqlCodegenConfig = (schemaUrl: string, generatePath: string, headers: Record<string, string>) => {
+  const config: CodegenConfig = {
+    overwrite: true,
+    schema: [
+      {
+        [schemaUrl]: {
+          headers,
+        },
+      },
+    ],
+    documents: [`${__dirname}/apps/demo/**/*.graphql`],
+    ignoreNoDocuments: true, // for better experience with the watcher
+    generates: {
+      [generatePath]: {
+        preset: 'client',
+      },
+    },
+  }
+
+  return config
+}
+
+export default graphqlCodegenConfig

package/src/lib/redirection.ts

@@ -0,0 +1,78 @@
+import { writeFile } from 'node:fs/promises'
+
+interface TFetchRedirectsConfig {
+  graphqlEndpoint: string
+  graphqlApiKey: string
+  redirectsFilename: string
+  rewritesFilename: string
+}
+/**
+ * Get Fetch Redirects Configuration
+ * @returns {object}
+ */
+export function getDefaultConfig(): TFetchRedirectsConfig {
+  return {
+    graphqlEndpoint: process.env['NEXT_PUBLIC_GRAPHQL_URL'] || '',
+    graphqlApiKey: process.env['NEXT_API_TOKEN_ADMIN'] || '',
+    redirectsFilename: './redirect/redirects.json',
+    rewritesFilename: './redirect/rewrites.json',
+  }
+}
+
+export async function fetchRedirects(config: TFetchRedirectsConfig): Promise<boolean> {
+  const { graphqlEndpoint, graphqlApiKey, redirectsFilename, rewritesFilename } = config
+
+  if (!graphqlEndpoint || !graphqlApiKey) {
+    throw new Error('Missing graphql configuration: NEXT_PUBLIC_GRAPHQL_URL or NEXT_API_TOKEN_ADMIN')
+  }
+
+  if (!redirectsFilename || !rewritesFilename) {
+    throw new Error('Missing filename')
+  }
+
+  const query = `query fetchRedirects {
+  redirects(filter: {status:{_eq:"published"},isrewrite:{_eq:false}}, sort: "sort") {
+    source
+    destination
+    permanent
+    locale
+  }
+  rewrites: redirects(filter: {status:{_eq:"published"},isrewrite:{_eq:true}}, sort: "sort") {
+    source
+    destination
+    permanent
+    locale
+  }
+}`
+
+  const graphqlBody = {
+    query,
+    // "operationName": "",
+    variables: {},
+  }
+
+  try {
+    // console.info(`Fetching redirects on ${graphqlEndpoint}`)
+    const response = await fetch(graphqlEndpoint, {
+      method: 'POST',
+      headers: {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${graphqlApiKey}`,
+      },
+      body: JSON.stringify(graphqlBody),
+    })
+    const { data } = await response.json()
+
+    const writeDataRedirects = JSON.stringify(data.redirects || [])
+    await writeFile(redirectsFilename, writeDataRedirects)
+
+    const writeDataRewrites = JSON.stringify(data.rewrites || [])
+    await writeFile(rewritesFilename, writeDataRewrites)
+  } catch (e) {
+    // console.error('GraphQL Error', (e as Error).message)
+    // return false
+  }
+
+  return true
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
+  "include": ["src/**/*.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
+}

package/src/index.d.ts

@@ -1 +0,0 @@
-export * from './lib/redirection';

package/src/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/redirection"), exports);
-//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/directus/directus-node/src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAiC"}

package/src/lib/redirection.d.ts

@@ -1,13 +0,0 @@
-interface TFetchRedirectsConfig {
-    graphqlEndpoint: string;
-    graphqlApiKey: string;
-    redirectsFilename: string;
-    rewritesFilename: string;
-}
-/**
- * Get Fetch Redirects Configuration
- * @returns {object}
- */
-export declare function getDefaultConfig(): TFetchRedirectsConfig;
-export declare function fetchRedirects(config: TFetchRedirectsConfig): Promise<boolean>;
-export {};

package/src/lib/redirection.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchRedirects = exports.getDefaultConfig = void 0;
-const tslib_1 = require("tslib");
-const promises_1 = require("node:fs/promises");
-/**
- * Get Fetch Redirects Configuration
- * @returns {object}
- */
-function getDefaultConfig() {
-    return {
-        graphqlEndpoint: process.env['NEXT_PUBLIC_GRAPHQL_URL'] || '',
-        graphqlApiKey: process.env['NEXT_API_TOKEN_ADMIN'] || '',
-        redirectsFilename: './redirect/redirects.json',
-        rewritesFilename: './redirect/rewrites.json',
-    };
-}
-exports.getDefaultConfig = getDefaultConfig;
-function fetchRedirects(config) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const { graphqlEndpoint, graphqlApiKey, redirectsFilename, rewritesFilename } = config;
-        if (!graphqlEndpoint || !graphqlApiKey) {
-            throw new Error('Missing graphql configuration: NEXT_PUBLIC_GRAPHQL_URL or NEXT_API_TOKEN_ADMIN');
-        }
-        if (!redirectsFilename || !rewritesFilename) {
-            throw new Error('Missing filename');
-        }
-        const query = `query fetchRedirects {
-  redirects(filter: {status:{_eq:"published"},isrewrite:{_eq:false}}, sort: "sort") {
-    source
-    destination
-    permanent
-    locale
-  }
-  rewrites: redirects(filter: {status:{_eq:"published"},isrewrite:{_eq:true}}, sort: "sort") {
-    source
-    destination
-    permanent
-    locale
-  }
-}`;
-        const graphqlBody = {
-            query,
-            // "operationName": "",
-            variables: {},
-        };
-        try {
-            // console.info(`Fetching redirects on ${graphqlEndpoint}`)
-            const response = yield fetch(graphqlEndpoint, {
-                method: 'POST',
-                headers: {
-                    // eslint-disable-next-line @typescript-eslint/naming-convention
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${graphqlApiKey}`,
-                },
-                body: JSON.stringify(graphqlBody),
-            });
-            const { data } = yield response.json();
-            const writeDataRedirects = JSON.stringify(data.redirects || []);
-            yield (0, promises_1.writeFile)(redirectsFilename, writeDataRedirects);
-            const writeDataRewrites = JSON.stringify(data.rewrites || []);
-            yield (0, promises_1.writeFile)(rewritesFilename, writeDataRewrites);
-        }
-        catch (e) {
-            // console.error('GraphQL Error', (e as Error).message)
-            // return false
-        }
-        return true;
-    });
-}
-exports.fetchRedirects = fetchRedirects;
-//# sourceMappingURL=redirection.js.map

package/src/lib/redirection.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"redirection.js","sourceRoot":"","sources":["../../../../../../libs/directus/directus-node/src/lib/redirection.ts"],"names":[],"mappings":";;;;AAAA,+CAA4C;AAQ5C;;;GAGG;AACH,SAAgB,gBAAgB;IAC9B,OAAO;QACL,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,IAAI,EAAE;QAC7D,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,IAAI,EAAE;QACxD,iBAAiB,EAAE,2BAA2B;QAC9C,gBAAgB,EAAE,0BAA0B;KAC7C,CAAA;AACH,CAAC;AAPD,4CAOC;AAED,SAAsB,cAAc,CAAC,MAA6B;;QAChE,MAAM,EAAE,eAAe,EAAE,aAAa,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAA;QAEtF,IAAI,CAAC,eAAe,IAAI,CAAC,aAAa,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAA;QACnG,CAAC;QAED,IAAI,CAAC,iBAAiB,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;QACrC,CAAC;QAED,MAAM,KAAK,GAAG;;;;;;;;;;;;;EAad,CAAA;QAEA,MAAM,WAAW,GAAG;YAClB,KAAK;YACL,uBAAuB;YACvB,SAAS,EAAE,EAAE;SACd,CAAA;QAED,IAAI,CAAC;YACH,2DAA2D;YAC3D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,eAAe,EAAE;gBAC5C,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,gEAAgE;oBAChE,cAAc,EAAE,kBAAkB;oBAClC,aAAa,EAAE,UAAU,aAAa,EAAE;iBACzC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;aAClC,CAAC,CAAA;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;YAEtC,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAA;YAC/D,MAAM,IAAA,oBAAS,EAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAA;YAEtD,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAA;YAC7D,MAAM,IAAA,oBAAS,EAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAA;QACtD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,uDAAuD;YACvD,eAAe;QACjB,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CAAA;AAxDD,wCAwDC"}