graphile-i18n 0.1.6 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +59 -46
- package/package.json +7 -7
package/LICENSE
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
The MIT License (MIT)
|
|
2
2
|
|
|
3
3
|
Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
|
|
4
|
-
Copyright (c) 2025
|
|
4
|
+
Copyright (c) 2025 Constructive <developers@constructive.io>
|
|
5
5
|
Copyright (c) 2020-present, Interweb, Inc.
|
|
6
6
|
|
|
7
7
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
package/README.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# graphile-i18n
|
|
2
2
|
|
|
3
3
|
<p align="center" width="100%">
|
|
4
|
-
<img height="250" src="https://raw.githubusercontent.com/
|
|
4
|
+
<img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
7
|
<p align="center" width="100%">
|
|
8
|
-
<a href="https://github.com/
|
|
9
|
-
<img height="20" src="https://github.com/
|
|
8
|
+
<a href="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml">
|
|
9
|
+
<img height="20" src="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml/badge.svg" />
|
|
10
10
|
</a>
|
|
11
|
-
<a href="https://github.com/
|
|
11
|
+
<a href="https://github.com/constructive-io/constructive/blob/main/LICENSE">
|
|
12
12
|
<img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/>
|
|
13
13
|
</a>
|
|
14
14
|
<a href="https://www.npmjs.com/package/graphile-i18n">
|
|
@@ -16,15 +16,22 @@
|
|
|
16
16
|
</a>
|
|
17
17
|
</p>
|
|
18
18
|
|
|
19
|
-
TypeScript rewrite of the Graphile/PostGraphile i18n plugin.
|
|
19
|
+
**`graphile-i18n`** is a TypeScript rewrite of the Graphile/PostGraphile i18n plugin. It adds language-aware fields sourced from translation tables declared via smart comments and respects `Accept-Language` with sensible fallbacks.
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## 🚀 Installation
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
24
|
pnpm add graphile-i18n
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## ✨ Features
|
|
28
|
+
|
|
29
|
+
- Smart comments (`@i18n`) to wire translation tables
|
|
30
|
+
- `Accept-Language` detection with graceful fallback to base values
|
|
31
|
+
- Works with PostGraphile context via `additionalGraphQLContextFromRequest`
|
|
32
|
+
- TypeScript-first implementation
|
|
33
|
+
|
|
34
|
+
## 📦 Usage
|
|
28
35
|
|
|
29
36
|
1. Add a translation table and tag the base table with `@i18n`:
|
|
30
37
|
|
|
@@ -70,85 +77,91 @@ app.use(
|
|
|
70
77
|
|
|
71
78
|
Requests with `Accept-Language` headers receive the closest translation; fields fall back to the base table values when a translation is missing.
|
|
72
79
|
|
|
73
|
-
##
|
|
80
|
+
## 🧰 Configuration Options
|
|
74
81
|
|
|
75
|
-
|
|
82
|
+
All options are provided through `graphileBuildOptions`:
|
|
76
83
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
84
|
+
- `langPluginLanguageCodeColumn` — translation table column name, default `lang_code`
|
|
85
|
+
- `langPluginLanguageCodeGqlField` — exposed GraphQL field name, default `langCode`
|
|
86
|
+
- `langPluginAllowedTypes` — allowed base column types for translation, default `['citext', 'text']`
|
|
87
|
+
- `langPluginDefaultLanguages` — fallback language order, default `['en']`
|
|
88
|
+
|
|
89
|
+
## 🧪 Testing
|
|
80
90
|
|
|
81
|
-
|
|
91
|
+
```sh
|
|
92
|
+
# requires a local Postgres available (defaults to postgres/password@localhost:5432)
|
|
93
|
+
pnpm --filter graphile-i18n test
|
|
94
|
+
```
|
|
82
95
|
|
|
83
96
|
---
|
|
84
97
|
|
|
85
98
|
## Education and Tutorials
|
|
86
99
|
|
|
87
|
-
1. 🚀 [Quickstart: Getting Up and Running](https://
|
|
100
|
+
1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
|
|
88
101
|
Get started with modular databases in minutes. Install prerequisites and deploy your first module.
|
|
89
102
|
|
|
90
|
-
2. 📦 [Modular PostgreSQL Development with Database Packages](https://
|
|
103
|
+
2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
|
|
91
104
|
Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
|
|
92
105
|
|
|
93
|
-
3. ✏️ [Authoring Database Changes](https://
|
|
106
|
+
3. ✏️ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
|
|
94
107
|
Master the workflow for adding, organizing, and managing database changes with pgpm.
|
|
95
108
|
|
|
96
|
-
4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://
|
|
109
|
+
4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
|
|
97
110
|
Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
|
|
98
111
|
|
|
99
|
-
5. ⚡ [Supabase Testing](https://
|
|
112
|
+
5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
|
|
100
113
|
Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
|
|
101
114
|
|
|
102
|
-
6. 💧 [Drizzle ORM Testing](https://
|
|
115
|
+
6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
|
|
103
116
|
Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
|
|
104
117
|
|
|
105
|
-
7. 🔧 [Troubleshooting](https://
|
|
118
|
+
7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
|
|
106
119
|
Common issues and solutions for pgpm, PostgreSQL, and testing.
|
|
107
120
|
|
|
108
|
-
## Related
|
|
121
|
+
## Related Constructive Tooling
|
|
109
122
|
|
|
110
123
|
### 🧪 Testing
|
|
111
124
|
|
|
112
|
-
* [
|
|
113
|
-
* [
|
|
114
|
-
* [
|
|
115
|
-
* [
|
|
125
|
+
* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/packages/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
|
|
126
|
+
* [supabase-test](https://github.com/constructive-io/constructive/tree/main/packages/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
|
|
127
|
+
* [graphile-test](https://github.com/constructive-io/constructive/tree/main/packages/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
|
|
128
|
+
* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/packages/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
|
|
116
129
|
|
|
117
130
|
### 🧠 Parsing & AST
|
|
118
131
|
|
|
119
|
-
* [
|
|
120
|
-
* [
|
|
121
|
-
* [
|
|
122
|
-
* [@pgsql/enums](https://
|
|
123
|
-
* [@pgsql/types](https://
|
|
124
|
-
* [@pgsql/utils](https://
|
|
125
|
-
* [
|
|
132
|
+
* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
|
|
133
|
+
* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
|
|
134
|
+
* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
|
|
135
|
+
* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
|
|
136
|
+
* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
|
|
137
|
+
* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
|
|
138
|
+
* [pg-ast](https://www.npmjs.com/package/pg-ast): **🔍 Low-level AST tools** and transformations for Postgres query structures.
|
|
126
139
|
|
|
127
140
|
### 🚀 API & Dev Tools
|
|
128
141
|
|
|
129
|
-
* [launchql/server](https://github.com/
|
|
130
|
-
* [launchql/explorer](https://github.com/
|
|
142
|
+
* [launchql/server](https://github.com/constructive-io/constructive/tree/main/packages/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
|
|
143
|
+
* [launchql/explorer](https://github.com/constructive-io/constructive/tree/main/packages/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
|
|
131
144
|
|
|
132
145
|
### 🔁 Streaming & Uploads
|
|
133
146
|
|
|
134
|
-
* [launchql/s3-streamer](https://github.com/
|
|
135
|
-
* [launchql/etag-hash](https://github.com/
|
|
136
|
-
* [launchql/etag-stream](https://github.com/
|
|
137
|
-
* [launchql/uuid-hash](https://github.com/
|
|
138
|
-
* [launchql/uuid-stream](https://github.com/
|
|
139
|
-
* [launchql/upload-names](https://github.com/
|
|
147
|
+
* [launchql/s3-streamer](https://github.com/constructive-io/constructive/tree/main/packages/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
|
|
148
|
+
* [launchql/etag-hash](https://github.com/constructive-io/constructive/tree/main/packages/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
|
|
149
|
+
* [launchql/etag-stream](https://github.com/constructive-io/constructive/tree/main/packages/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
|
|
150
|
+
* [launchql/uuid-hash](https://github.com/constructive-io/constructive/tree/main/packages/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
|
|
151
|
+
* [launchql/uuid-stream](https://github.com/constructive-io/constructive/tree/main/packages/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
|
|
152
|
+
* [launchql/upload-names](https://github.com/constructive-io/constructive/tree/main/packages/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
|
|
140
153
|
|
|
141
154
|
### 🧰 CLI & Codegen
|
|
142
155
|
|
|
143
|
-
* [pgpm](https://github.com/
|
|
144
|
-
* [@launchql/cli](https://github.com/
|
|
145
|
-
* [launchql/launchql-gen](https://github.com/
|
|
146
|
-
* [@launchql/query-builder](https://github.com/
|
|
147
|
-
* [@launchql/query](https://github.com/
|
|
156
|
+
* [pgpm](https://github.com/constructive-io/constructive/tree/main/packages/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
|
|
157
|
+
* [@launchql/cli](https://github.com/constructive-io/constructive/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing LaunchQL projects—supports database scaffolding, migrations, seeding, code generation, and automation.
|
|
158
|
+
* [launchql/launchql-gen](https://github.com/constructive-io/constructive/tree/main/packages/launchql-gen): **✨ Auto-generated GraphQL** mutations and queries dynamically built from introspected schema data.
|
|
159
|
+
* [@launchql/query-builder](https://github.com/constructive-io/constructive/tree/main/packages/query-builder): **🏗️ SQL constructor** providing a robust TypeScript-based query builder for dynamic generation of `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and stored procedure calls—supports advanced SQL features like `JOIN`, `GROUP BY`, and schema-qualified queries.
|
|
160
|
+
* [@launchql/query](https://github.com/constructive-io/constructive/tree/main/packages/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
|
|
148
161
|
|
|
149
162
|
## Credits
|
|
150
163
|
|
|
151
|
-
🛠 Built by
|
|
164
|
+
🛠 Built by Constructive — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/constructive-io)
|
|
152
165
|
|
|
153
166
|
|
|
154
167
|
## Disclaimer
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "graphile-i18n",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.8",
|
|
4
4
|
"description": "Graphile i18n plugin",
|
|
5
5
|
"author": "Dan Lynch <pyramation@gmail.com>",
|
|
6
|
-
"homepage": "https://github.com/
|
|
6
|
+
"homepage": "https://github.com/constructive-io/constructive",
|
|
7
7
|
"license": "MIT",
|
|
8
8
|
"main": "index.js",
|
|
9
9
|
"module": "esm/index.js",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
},
|
|
25
25
|
"repository": {
|
|
26
26
|
"type": "git",
|
|
27
|
-
"url": "https://github.com/
|
|
27
|
+
"url": "https://github.com/constructive-io/constructive"
|
|
28
28
|
},
|
|
29
29
|
"keywords": [
|
|
30
30
|
"postgraphile",
|
|
@@ -35,14 +35,14 @@
|
|
|
35
35
|
"graphql"
|
|
36
36
|
],
|
|
37
37
|
"bugs": {
|
|
38
|
-
"url": "https://github.com/
|
|
38
|
+
"url": "https://github.com/constructive-io/constructive/issues"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@types/accept-language-parser": "^1.5.4",
|
|
42
42
|
"@types/pg": "^8.15.2",
|
|
43
|
-
"graphile-test": "^2.8.
|
|
43
|
+
"graphile-test": "^2.8.12",
|
|
44
44
|
"makage": "^0.1.8",
|
|
45
|
-
"pgsql-test": "^2.14.
|
|
45
|
+
"pgsql-test": "^2.14.15"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"accept-language-parser": "^1.5.0",
|
|
@@ -55,5 +55,5 @@
|
|
|
55
55
|
"graphql-tag": "2.12.6",
|
|
56
56
|
"pg": "^8.16.0"
|
|
57
57
|
},
|
|
58
|
-
"gitHead": "
|
|
58
|
+
"gitHead": "5a0d7c7502624bd42a214f983fd7ab957e1fb3e3"
|
|
59
59
|
}
|