@baeta/plugin-pagination 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @baeta/plugin-pagination
 
+## 0.1.4
+
+### Patch Changes
+
+- [`b59db50`](https://github.com/andreisergiu98/baeta/commit/b59db501a83275ab2d964933080e688a3a5d8820) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - add readme
+
+- Updated dependencies [[`b59db50`](https://github.com/andreisergiu98/baeta/commit/b59db501a83275ab2d964933080e688a3a5d8820)]:
+  - @baeta/generator-sdk@0.1.4
+  - @baeta/util-path@0.1.4
+
+## 0.1.3
+
+### Patch Changes
+
+- [#180](https://github.com/andreisergiu98/baeta/pull/180) [`483c709`](https://github.com/andreisergiu98/baeta/commit/483c70932f815fd114732c00b74f9488d7924c72) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Raise minimum required NodeJS version to 22.12.0. Drop CommonJS builds in favor of the require_esm feature from NodeJS 22.12.0 onwards.
+
+- [`de6e89c`](https://github.com/andreisergiu98/baeta/commit/de6e89c1b592e280967c73a4137d24ee56ef1857) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - raise es target to 2024
+
+- Updated dependencies [[`483c709`](https://github.com/andreisergiu98/baeta/commit/483c70932f815fd114732c00b74f9488d7924c72), [`de6e89c`](https://github.com/andreisergiu98/baeta/commit/de6e89c1b592e280967c73a4137d24ee56ef1857)]:
+  - @baeta/generator-sdk@0.1.3
+  - @baeta/util-path@0.1.3
+
 ## 0.1.2
 
 ### Patch Changes

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Pampu Andrei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,139 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/andreisergiu98/baeta/refs/heads/main/website/static/img/logo-baeta.svg" alt="Baeta Logo" width="150"/>
+</p>
+
+<div align="center">
+  <h1>Baeta</h1>
+  <a href="https://www.npmjs.com/package/@baeta/cli"><img src="https://img.shields.io/npm/v/@baeta/cli.svg?style=flat" /></a>
+   <a href="https://github.com/andreisergiu98/baeta/actions/workflows/testing.yml"><img src="https://img.shields.io/github/actions/workflow/status/andreisergiu98/baeta/testing.yml" /></a>
+  <a href="https://github.com/andreisergiu98/baeta/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a>
+  <a href="https://github.com/andreisergiu98/baeta/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" /></a>
+  <br />
+  <br />
+  <a href="https://baeta.io/docs/getting-started/installation">Getting Started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://www.baeta.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://baeta.io/docs/intro">Docs</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://github.com/andreisergiu98/baeta/tree/main/examples">Examples</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://discord.gg/BHFXHvyj">Discord</a>
+  <br />
+  <hr />
+</div>
+
+# What is Baeta?
+
+Building GraphQL APIs shouldn't be complicated. **Baeta** is a modern, modular, open-source GraphQL framework designed with flexibility in mind. It follows a granular approach where you only add what you need, helping developers focus on what matters most - creating powerful, scalable APIs without the boilerplate.
+
+### Key Features
+
+- **Modular Architecture**: Organize your API into manageable modules
+- **Schema-First Development**: Define your API contract upfront
+- **Type Safety**: Automatic code generation for type-safe development
+- **Middleware & Directives**: Easy integration of custom behaviors
+- **High Performance**: Built for scalability and efficiency
+
+#### And optional extensions and plugins
+
+- **@baeta/extension-auth**: Add powerful scope-based authorization
+- **@baeta/extension-cache**: Implement automatic caching with simple update patterns
+- ... and more!
+
+## Why use Baeta?
+
+Baeta makes it easy to build better GraphQL APIs while staying flexible. Here's how:
+
+**Granular and Progressive:** Start small and add features as you need them. Whether you're building a simple API or a complex system, Baeta scales with your needs.
+
+**Modular architecture:** Baeta's modular design allows you to organize your GraphQL API into smaller, more manageable modules that can be added or removed as needed. This makes it easier to maintain and scale your API over time.
+
+**Schema-first approach:** With Baeta, you define your schema first, and then logic and resolvers. This approach ensures a consistent and well-defined API for your clients and reduces boilerplate code.
+
+## How it Works
+
+#### 1. Define your schema
+
+```graphql
+type User {
+  id: ID!
+  name: String!
+  email: String!
+  age: Int
+}
+
+input UserWhereUnique {
+  id: ID
+  email: String
+}
+
+type Query {
+  user(where: UserWhereUnique!): User!
+  users: [User!]!
+}
+```
+
+#### 2. Implement your resolvers
+
+```typescript
+import { getUserModule } from "./typedef";
+
+const { Query } = getUserModule();
+
+Query.user(({ args }) => {
+  return dataSource.user.find(args.where);
+});
+
+Query.users(() => {
+  return dataSource.user.findMany();
+});
+```
+
+#### 3. Add authorization
+
+```typescript
+const { Query, Mutation } = getUserModule();
+
+Query.users.$auth({
+  $or: {
+    isPublic: true,
+    isLoggedIn: true,
+  },
+});
+```
+
+#### 4. Add caching
+
+```typescript
+import { getUserModule } from "./typedef";
+
+const { User, Query } = getUserModule();
+
+export const userCache = User.$createCache();
+
+Query.user.$useCache(userCache);
+Query.users.$useCache(userCache);
+```
+
+## Compatibility
+
+Baeta is compatible with all GraphQL servers, which makes it easy to integrate with your existing stack. It works seamlessly with popular GraphQL server libraries such as **Graphql Yoga** and **Apollo Server**, as well as other popular tools like **Prisma**, **Drizzle** and **Kysely**.
+
+Baeta's development tools are built for Node.js, but the runtime code is environment-agnostic. This means your Baeta applications can run anywhere JavaScript runs, including:
+
+- Deno
+- Cloudflare Workers
+- AWS Lambda
+- Vercel Edge Functions
+- Bun
+- Node.js
+- Any other JavaScript runtime
+
+## Credits
+
+Baeta was inspired by several amazing projects and people in the GraphQL ecosystem. Check out our [Credits page](https://baeta.io/docs/credits) to learn more about the individuals and projects that influenced Baeta's development.
+
+## License
+
+Baeta is licensed under the [MIT License](./LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baeta/plugin-pagination",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "keywords": [
     "baeta",
     "graphql",
@@ -28,8 +28,7 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "default": "./dist/index.js"
     }
   },
   "types": "dist/index.d.ts",
@@ -44,29 +43,28 @@
     "types": "tsc --noEmit"
   },
   "dependencies": {
-    "@baeta/generator-sdk": "^0.1.2",
-    "@baeta/util-path": "^0.1.2"
+    "@baeta/generator-sdk": "^0.1.4",
+    "@baeta/util-path": "^0.1.4"
   },
   "devDependencies": {
     "@baeta/builder": "^0.0.0",
     "@baeta/tsconfig": "^0.0.0",
-    "@types/node": "^22.9.1",
+    "@types/node": "^22.10.1",
     "graphql": "^16.9.0",
-    "typescript": "^5.6.3"
+    "typescript": "^5.7.2"
   },
   "peerDependencies": {
     "graphql": "^16.6.0"
   },
   "engines": {
-    "node": ">=22.0.0"
+    "node": ">=22.12.0"
   },
   "publishConfig": {
     "access": "public",
     "exports": {
       ".": {
         "types": "./dist/index.d.ts",
-        "import": "./dist/index.js",
-        "require": "./dist/index.cjs"
+        "default": "./dist/index.js"
       }
     }
   },
@@ -78,5 +76,12 @@
       "--no-warnings",
       "--experimental-transform-types"
     ]
+  },
+  "typedocOptions": {
+    "entryPoints": [
+      "./index.ts"
+    ],
+    "readme": "none",
+    "tsconfig": "./tsconfig.json"
   }
 }

package/dist/index.cjs

@@ -1,109 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});// index.ts
-var _generatorsdk = require('@baeta/generator-sdk');
-var _utilpath = require('@baeta/util-path');
-function printFields(fields) {
-  return fields.map((field) => `  ${field}`).join("\n");
-}
-function printType(name, fields) {
-  return `type ${name} {
-${printFields(fields)}
-}`;
-}
-function printTypes(types) {
-  return `${types.join("\n\n")}
-`;
-}
-function printPageInfo(addFields = []) {
-  return printType("PageInfo", [
-    ...addFields,
-    "hasPreviousPage: Boolean!",
-    "hasNextPage: Boolean!"
-  ]);
-}
-function printExport(moduleDefinitionName, moduleName, importExt = "") {
-  const parsed = _utilpath.parse.call(void 0, moduleDefinitionName);
-  const method = _generatorsdk.getModuleGetName.call(void 0, moduleName);
-  const importName = parsed.ext === ".ts" ? parsed.name : moduleDefinitionName;
-  return `import { ${method} } from "./${importName}${importExt}";
-
-export const ${_generatorsdk.getModuleVariableName.call(void 0, moduleName)} = ${method}();
-`;
-}
-function printConnectionTypes(name, typeOptions, options) {
-  const {
-    cursorType = "String!",
-    nodeType = name,
-    connectionFields = [],
-    edgeFields = []
-  } = typeOptions;
-  const connection = printType(`${name}Connection`, [
-    ...connectionFields,
-    "pageInfo: PageInfo!",
-    `edges: [${name}Edge]`
-  ]);
-  const edge = printType(`${name}Edge`, [
-    ...edgeFields,
-    `cursor: ${cursorType}`,
-    `node: ${nodeType}${options.nullableNode === false ? "!" : ""}`
-  ]);
-  return [connection, edge];
-}
-function createConnectionModuleDir(modulesDir, moduleName) {
-  return _utilpath.join.call(void 0, modulesDir, moduleName);
-}
-function createGqlFilename(moduleDir) {
-  return `${moduleDir}/connections.gql`;
-}
-function createExportFilename(moduleDir) {
-  return `${moduleDir}/index.ts`;
-}
-function paginationPlugin(options) {
-  const { moduleName = "baeta-pagination" } = options;
-  return _generatorsdk.createPluginV1.call(void 0, {
-    name: "pagination",
-    actionName: "pagination connections",
-    watch: (generatorOptions, watcher) => {
-      watcher.ignore(`${createConnectionModuleDir(generatorOptions.modulesDir, moduleName)}/**`);
-    },
-    generate: async (ctx, next) => {
-      const types = [printPageInfo(options.pageInfoFields)];
-      for (const name in options.types) {
-        const typeOptions = options.types[name];
-        if (typeOptions === false) {
-          continue;
-        }
-        const connectionTypes = printConnectionTypes(
-          name,
-          typeOptions === true ? {} : typeOptions,
-          options
-        );
-        types.push(...connectionTypes);
-      }
-      const moduleDir = createConnectionModuleDir(ctx.generatorOptions.modulesDir, moduleName);
-      const definitionFile = ctx.fileManager.createAndAdd(
-        createGqlFilename(moduleDir),
-        printTypes(types),
-        "pagination"
-      );
-      await definitionFile.write();
-      ctx.fileManager.add(definitionFile);
-      if (options.createExport === false) {
-        return next();
-      }
-      ctx.fileManager.createAndAdd(
-        createExportFilename(moduleDir),
-        printExport(
-          ctx.generatorOptions.moduleDefinitionName,
-          moduleName,
-          ctx.generatorOptions.importExtension
-        ),
-        "pagination"
-      );
-      return next();
-    }
-  });
-}
-
-
-exports.paginationPlugin = paginationPlugin;
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["/home/runner/work/baeta/baeta/packages/plugin-pagination/dist/index.cjs","../index.ts"],"names":[],"mappings":"AAAA;ACAA,oDAAwE;AACxE,4CAA4B;AAiB5B,SAAS,WAAA,CAAY,MAAA,EAAkB;AACtC,EAAA,OAAO,MAAA,CAAO,GAAA,CAAI,CAAC,KAAA,EAAA,GAAU,CAAA,EAAA,EAAK,KAAK,CAAA,CAAA;AACxC;AAEmD;AAC/B,EAAA;AACC;AAAA,CAAA;AAErB;AAEqC;AACR,EAAA;AAAA;AAC7B;AAEiD;AACnB,EAAA;AACzB,IAAA;AACH,IAAA;AACA,IAAA;AACA,EAAA;AACF;AAEqB;AACC,EAAA;AACW,EAAA;AACE,EAAA;AAEK,EAAA;AAAsB;AAEzB,aAAA;AAAuB;AAE5D;AAE4C;AACrC,EAAA;AACQ,IAAA;AACF,IAAA;AACS,IAAA;AACN,IAAA;AACX,EAAA;AAEgC,EAAA;AAChC,IAAA;AACH,IAAA;AACe,IAAA;AACf,EAAA;AAEqC,EAAA;AAClC,IAAA;AACkB,IAAA;AACO,IAAA;AAC5B,EAAA;AAEuB,EAAA;AACzB;AAEmC;AACA,EAAA;AACnC;AAE8C;AAC1B,EAAA;AACpB;AAEiD;AAC7B,EAAA;AACpB;AAE6D;AACpB,EAAA;AAElB,EAAA;AACf,IAAA;AACM,IAAA;AAC0B,IAAA;AACnB,MAAA;AACnB,IAAA;AAC+B,IAAA;AACS,MAAA;AAEL,MAAA;AACC,QAAA;AAEP,QAAA;AAC1B,UAAA;AACD,QAAA;AAEwB,QAAA;AACvB,UAAA;AAC4B,UAAA;AAC5B,UAAA;AACD,QAAA;AAE6B,QAAA;AAC9B,MAAA;AAEkB,MAAA;AAES,MAAA;AACC,QAAA;AACX,QAAA;AAChB,QAAA;AACD,MAAA;AAC2B,MAAA;AAEO,MAAA;AAEE,MAAA;AACvB,QAAA;AACb,MAAA;AAEgB,MAAA;AACe,QAAA;AAC9B,QAAA;AACsB,UAAA;AACrB,UAAA;AACqB,UAAA;AACtB,QAAA;AACA,QAAA;AACD,MAAA;AAEY,MAAA;AACb,IAAA;AACA,EAAA;AACF;ADrC0C;AACA;AACA","file":"/home/runner/work/baeta/baeta/packages/plugin-pagination/dist/index.cjs","sourcesContent":[null,"import { createPluginV1, getModuleGetName, getModuleVariableName } from '@baeta/generator-sdk';\nimport { join, parse } from '@baeta/util-path';\n\ninterface TypeOptions {\n\tnodeType?: string;\n\tcursorType?: string;\n\tedgeFields?: string[];\n\tconnectionFields?: string[];\n}\n\ninterface PaginationOptions {\n\ttypes: Record<string, boolean | TypeOptions>;\n\tnullableNode?: boolean;\n\tpageInfoFields?: string[];\n\tmoduleName?: string;\n\tcreateExport?: boolean;\n}\n\nfunction printFields(fields: string[]) {\n\treturn fields.map((field) => `  ${field}`).join('\\n');\n}\n\nfunction printType(name: string, fields: string[]) {\n\treturn `type ${name} {\n${printFields(fields)}\n}`;\n}\n\nfunction printTypes(types: string[]) {\n\treturn `${types.join('\\n\\n')}\\n`;\n}\n\nfunction printPageInfo(addFields: string[] = []) {\n\treturn printType('PageInfo', [\n\t\t...addFields,\n\t\t'hasPreviousPage: Boolean!',\n\t\t'hasNextPage: Boolean!',\n\t]);\n}\n\nfunction printExport(moduleDefinitionName: string, moduleName: string, importExt = '') {\n\tconst parsed = parse(moduleDefinitionName);\n\tconst method = getModuleGetName(moduleName);\n\tconst importName = parsed.ext === '.ts' ? parsed.name : moduleDefinitionName;\n\n\treturn `import { ${method} } from \"./${importName}${importExt}\";\n\nexport const ${getModuleVariableName(moduleName)} = ${method}();\n`;\n}\n\nfunction printConnectionTypes(name: string, typeOptions: TypeOptions, options: PaginationOptions) {\n\tconst {\n\t\tcursorType = 'String!',\n\t\tnodeType = name,\n\t\tconnectionFields = [],\n\t\tedgeFields = [],\n\t} = typeOptions;\n\n\tconst connection = printType(`${name}Connection`, [\n\t\t...connectionFields,\n\t\t'pageInfo: PageInfo!',\n\t\t`edges: [${name}Edge]`,\n\t]);\n\n\tconst edge = printType(`${name}Edge`, [\n\t\t...edgeFields,\n\t\t`cursor: ${cursorType}`,\n\t\t`node: ${nodeType}${options.nullableNode === false ? '!' : ''}`,\n\t]);\n\n\treturn [connection, edge];\n}\n\nfunction createConnectionModuleDir(modulesDir: string, moduleName: string) {\n\treturn join(modulesDir, moduleName);\n}\n\nfunction createGqlFilename(moduleDir: string) {\n\treturn `${moduleDir}/connections.gql`;\n}\n\nfunction createExportFilename(moduleDir: string) {\n\treturn `${moduleDir}/index.ts`;\n}\n\nexport function paginationPlugin(options: PaginationOptions) {\n\tconst { moduleName = 'baeta-pagination' } = options;\n\n\treturn createPluginV1({\n\t\tname: 'pagination',\n\t\tactionName: 'pagination connections',\n\t\twatch: (generatorOptions, watcher) => {\n\t\t\twatcher.ignore(`${createConnectionModuleDir(generatorOptions.modulesDir, moduleName)}/**`);\n\t\t},\n\t\tgenerate: async (ctx, next) => {\n\t\t\tconst types: string[] = [printPageInfo(options.pageInfoFields)];\n\n\t\t\tfor (const name in options.types) {\n\t\t\t\tconst typeOptions = options.types[name];\n\n\t\t\t\tif (typeOptions === false) {\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\tconst connectionTypes = printConnectionTypes(\n\t\t\t\t\tname,\n\t\t\t\t\ttypeOptions === true ? {} : typeOptions,\n\t\t\t\t\toptions,\n\t\t\t\t);\n\n\t\t\t\ttypes.push(...connectionTypes);\n\t\t\t}\n\n\t\t\tconst moduleDir = createConnectionModuleDir(ctx.generatorOptions.modulesDir, moduleName);\n\n\t\t\tconst definitionFile = ctx.fileManager.createAndAdd(\n\t\t\t\tcreateGqlFilename(moduleDir),\n\t\t\t\tprintTypes(types),\n\t\t\t\t'pagination',\n\t\t\t);\n\t\t\tawait definitionFile.write();\n\n\t\t\tctx.fileManager.add(definitionFile);\n\n\t\t\tif (options.createExport === false) {\n\t\t\t\treturn next();\n\t\t\t}\n\n\t\t\tctx.fileManager.createAndAdd(\n\t\t\t\tcreateExportFilename(moduleDir),\n\t\t\t\tprintExport(\n\t\t\t\t\tctx.generatorOptions.moduleDefinitionName,\n\t\t\t\t\tmoduleName,\n\t\t\t\t\tctx.generatorOptions.importExtension,\n\t\t\t\t),\n\t\t\t\t'pagination',\n\t\t\t);\n\n\t\t\treturn next();\n\t\t},\n\t});\n}\n"]}

package/dist/index.d.cts

@@ -1,18 +0,0 @@
-import * as _baeta_generator_sdk from '@baeta/generator-sdk';
-
-interface TypeOptions {
-    nodeType?: string;
-    cursorType?: string;
-    edgeFields?: string[];
-    connectionFields?: string[];
-}
-interface PaginationOptions {
-    types: Record<string, boolean | TypeOptions>;
-    nullableNode?: boolean;
-    pageInfoFields?: string[];
-    moduleName?: string;
-    createExport?: boolean;
-}
-declare function paginationPlugin(options: PaginationOptions): _baeta_generator_sdk.GeneratorPluginV1<unknown>;
-
-export { paginationPlugin };