@wbce/projen-d9 0.0.28 → 0.1.1

package/.jsii

@@ -7,15 +7,18 @@
     ]
   },
   "bin": {
-    "wbce-d9": "lib/cli/index.js",
+    "d9-plumbing": "lib/cli/index.js",
     "wbce-directus": "lib/cli/index.js"
   },
   "bundled": {
+    "@cedar-policy/cedar-wasm": "^4.13.0",
     "@types/pg": "^8.20.0",
     "@types/pg-copy-streams": "^1.2.5",
     "commander": "^14.0.3",
     "pg": "^8.20.0",
-    "pg-copy-streams": "^7.0.0"
+    "pg-copy-streams": "^7.0.0",
+    "pino": "^10.4.0",
+    "pino-pretty": "^13.2.0"
   },
   "dependencies": {
     "@wbce/projen-d9-extension": "^0.0.15",
@@ -122,7 +125,7 @@
   },
   "name": "@wbce/projen-d9",
   "readme": {
-    "markdown": "# @wbce/projen-d9\n\nProjen template for [d9](https://github.com/LaWebcapsule/d9) projects (fork of Directus v9). Scaffolds a local development setup with Docker Compose (Postgres + Redis), extension management, and GitHub workflows — then produces a Docker image you can deploy to any environment.\n\n\nCompanion package: [`@wbce/projen-d9-extension`](../directus-extension) for authoring extensions.\n\n## Bootstrap a new project\n\n```sh\nnpx projen new --from @wbce/projen-d9\n```\n\nThis creates a `.projenrc.js` and synthesizes the project.\n\n## Usage\n\n`.projenrc.js`:\n\n```js\nimport { D9Project } from '@wbce/projen-d9';\nimport { D9ExtensionType } from '@wbce/projen-d9-extension';\n\nconst project = new D9Project({\n  name: 'my-d9',\n  defaultReleaseBranch: 'main',\n  eslintOptions: {\n    dirs: ['src', 'test'],\n    prettier: true,\n  },\n});\n\n// A shared package other extensions can depend on\nproject.addExtension('shared', []);\n\n// A hook extension that depends on the shared package\nconst myHook = project.addExtension('my-hook', [D9ExtensionType.HOOK]);\nmyHook.addDeps('shared@workspace:');\n\nproject.synth();\n```\n\nThen synth and start it:\n\n```sh\nnpx projen\nnpx projen first-run   # boot stack + create admin user\nnpx projen run         # start d9 (port 8055)\n```\n\nThe default admin user is `admin@example.com` / `totototo`.\n\n### Extension types\n\n`D9ExtensionType` values: `INTERFACE`, `DISPLAY`, `LAYOUT`, `MODULE`, `PANEL`, `ENDPOINT`, `HOOK`, `OPERATION`. Pass an empty array for a shared (non-extension) package.\n\nExtensions live under `./plugins/` (configurable via `extensionsFolderName`) and are built by the `build-extensions` task.\n\n## Generated tasks\n\n| Task | Description |\n| --- | --- |\n| `first-run` | Boot the stack, create admin, start d9 |\n| `run` | Start d9 (`docker compose up directus`) |\n| `build-extensions` | Install and build all extensions |\n| `create-an-admin` | Create the default admin user |\n\n## What gets generated\n\n- `docker-compose.yml` — d9, Postgres (PostGIS), Redis with healthchecks\n- `Dockerfile` — Node 22 + pnpm, builds extensions\n- `.env.local` — sample for local environment overrides\n- GitHub workflows via [`@wbce/projen-shared`](../shared) (set `githubConfig: false` to disable)\n\n## Options\n\nSee [API.md](./API.md) for the full `D9ProjectOptions` reference. Highlights:\n\n- `extensionsFolderName` — folder for extension packages (default: `plugins`)\n- `packageVersions.d9` — version of `@wbce-d9/directus9` (default: `12.0.1`)\n- `packageVersions.atlas` — version of `@ariga/atlas` (default: `0.32.0`)\n- `githubConfig` — `GitHubConfigOptions` or `false` to disable"
+    "markdown": "# @wbce/projen-d9\n\nProjen template for [d9](https://github.com/LaWebcapsule/d9) projects (fork of Directus v9). Scaffolds a local development setup with Docker Compose (Postgres + Redis), extension management, and GitHub workflows — then produces a Docker image you can deploy to any environment.\n\nThe generated stack (Docker Compose, first run) and `d9-plumbing` assume PostgreSQL as the d9 database; extensions, the Dockerfile and the GitHub workflows do not depend on it. Support for other databases may be added in the future.\n\nCompanion package: [`@wbce/projen-d9-extension`](../directus-extension) for authoring extensions.\n\n## Bootstrap a new project\n\n```sh\nnpx projen new --from @wbce/projen-d9\n```\n\nThis creates a `.projenrc.js` and synthesizes the project.\n\n## Usage\n\n`.projenrc.js`:\n\n```js\nimport { D9Project } from '@wbce/projen-d9';\nimport { D9ExtensionType } from '@wbce/projen-d9-extension';\n\nconst project = new D9Project({\n  name: 'my-d9',\n  defaultReleaseBranch: 'main',\n  eslintOptions: {\n    dirs: ['src', 'test'],\n    prettier: true,\n  },\n});\n\n// A shared package other extensions can depend on\nproject.addExtension('shared', []);\n\n// A hook extension that depends on the shared package\nconst myHook = project.addExtension('my-hook', [D9ExtensionType.HOOK]);\nmyHook.addDeps('shared@workspace:');\n\nproject.synth();\n```\n\nThen synth and start it:\n\n```sh\nnpx projen\nnpx projen first-run   # boot stack + create admin user\nnpx projen run         # start d9 (port 8055)\n```\n\nThe default admin user is `admin@example.com` / `totototo`.\n\n### Extension types\n\n`D9ExtensionType` values: `INTERFACE`, `DISPLAY`, `LAYOUT`, `MODULE`, `PANEL`, `ENDPOINT`, `HOOK`, `OPERATION`. Pass an empty array for a shared (non-extension) package.\n\nExtensions live under `./plugins/` (configurable via `extensionsFolderName`) and are built by the `build-extensions` task.\n\n## Generated tasks\n\n| Task | Description |\n| --- | --- |\n| `first-run` | Boot the stack, create admin, start d9 |\n| `run` | Start d9 (`docker compose up d9`) |\n| `build-extensions` | Install and build all extensions |\n| `create-an-admin` | Create the default admin user |\n\n## d9-plumbing CLI\n\nThe package ships the `d9-plumbing` CLI to save a d9 instance (schema, data, files, Cedar permissions) into the repository and apply it to other environments. See [docs/D9-plumbing.md](./docs/D9-plumbing.md).\n\n`d9-plumbing` currently supports PostgreSQL only. Support for other databases may be added in the future.\n\n## What gets generated\n\n- `docker-compose.yml` — d9, Postgres (PostGIS), Redis with healthchecks\n- `Dockerfile` — Node 22 + pnpm, builds extensions\n- `.env.local` — sample for local environment overrides\n- GitHub workflows via [`@wbce/projen-shared`](../shared) (set `githubConfig: false` to disable)\n\n## Options\n\nSee [API.md](./API.md) for the full `D9ProjectOptions` reference. Highlights:\n\n- `extensionsFolderName` — folder for extension packages (default: `plugins`)\n- `packageVersions.d9` — version of `@wbce-d9/directus9` (default: `12.0.15`)\n- `packageVersions.atlas` — version of the Atlas Community Edition binary (Apache 2.0) that `d9-plumbing` downloads from release.ariga.io on first use, cached in `node_modules/.cache/d9-plumbing` (default: `1.3.3`)\n- `githubConfig` — `GitHubConfigOptions` or `false` to disable"
   },
   "repository": {
     "type": "git",
@@ -148,7 +151,7 @@
         },
         "locationInModule": {
           "filename": "src/index.ts",
-          "line": 46
+          "line": 86
         },
         "parameters": [
           {
@@ -162,7 +165,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 33
+        "line": 73
       },
       "methods": [
         {
@@ -171,7 +174,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 158
+            "line": 201
           },
           "name": "addExtension",
           "parameters": [
@@ -205,6 +208,24 @@
               "fqn": "@wbce/projen-d9-extension.D9ExtensionProject"
             }
           }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 205
+          },
+          "name": "configurePlumbing",
+          "parameters": [
+            {
+              "name": "options",
+              "type": {
+                "fqn": "@wbce/projen-d9.PlumbingOptions"
+              }
+            }
+          ]
         }
       ],
       "name": "D9Project",
@@ -216,7 +237,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 35
+            "line": 75
           },
           "name": "githubConfig",
           "optional": true,
@@ -230,20 +251,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 38
-          },
-          "name": "applySchemaTask",
-          "type": {
-            "fqn": "projen.Task"
-          }
-        },
-        {
-          "docs": {
-            "stability": "stable"
-          },
-          "locationInModule": {
-            "filename": "src/index.ts",
-            "line": 39
+            "line": 78
           },
           "name": "buildExtensionTask",
           "type": {
@@ -256,7 +264,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 44
+            "line": 83
           },
           "name": "cacheService",
           "type": {
@@ -269,9 +277,9 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 43
+            "line": 81
           },
-          "name": "databaseService",
+          "name": "d9Service",
           "type": {
             "fqn": "projen.DockerComposeService"
           }
@@ -282,9 +290,9 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 42
+            "line": 82
           },
-          "name": "directusService",
+          "name": "databaseService",
           "type": {
             "fqn": "projen.DockerComposeService"
           }
@@ -295,7 +303,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 41
+            "line": 80
           },
           "name": "dockerComposeFile",
           "type": {
@@ -308,7 +316,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 40
+            "line": 79
           },
           "name": "dockerfile",
           "type": {
@@ -321,7 +329,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 37
+            "line": 77
           },
           "name": "extensionFolder",
           "type": {
@@ -334,7 +342,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 36
+            "line": 76
           },
           "name": "extensions",
           "type": {
@@ -347,7 +355,7 @@
           },
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 46
+            "line": 86
           },
           "name": "options",
           "protected": true,
@@ -371,7 +379,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 17
+        "line": 57
       },
       "name": "D9ProjectOptions",
       "properties": [
@@ -385,7 +393,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 29
+            "line": 69
           },
           "name": "extensionsFolderName",
           "optional": true,
@@ -404,7 +412,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 23
+            "line": 63
           },
           "name": "githubConfig",
           "optional": true,
@@ -429,7 +437,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/index.ts",
-            "line": 30
+            "line": 70
           },
           "name": "packageVersions",
           "optional": true,
@@ -454,7 +462,7 @@
         },
         "locationInModule": {
           "filename": "src/index.ts",
-          "line": 46
+          "line": 86
         },
         "parameters": [
           {
@@ -468,7 +476,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 380
+        "line": 438
       },
       "name": "DirectusProject",
       "symbolId": "src/index:DirectusProject"
@@ -487,11 +495,91 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/index.ts",
-        "line": 375
+        "line": 433
       },
       "name": "DirectusProjectOptions",
       "symbolId": "src/index:DirectusProjectOptions"
     },
+    "@wbce/projen-d9.IntermediateStorageOptions": {
+      "assembly": "@wbce/projen-d9",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Storage shared between environments, used by `d9-plumbing save` and `d9-plumbing apply-schema` to transfer files."
+      },
+      "fqn": "@wbce/projen-d9.IntermediateStorageOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/index.ts",
+        "line": 19
+      },
+      "name": "IntermediateStorageOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The storage driver: s3, gcs, azure, local or cloudinary."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 23
+          },
+          "name": "driver",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Non-secret driver options (root, bucket, region, endpoint...)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 27
+          },
+          "name": "options",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "example": "{ key: 'S3_ACCESS_KEY_ID_ENV_VAR', secret: 'S3_SECRET_ACCESS_KEY_ENV_VAR' } // the `secret` option is read from $S3_SECRET_ACCESS_KEY_ENV_VAR",
+            "remarks": "Only the variable name is written to `d9-plumbing.json`, never the value: it is read from the environment (or `.env`) at runtime.",
+            "stability": "stable",
+            "summary": "Secret driver options, mapping each option name to the name of the environment variable holding its value."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 33
+          },
+          "name": "secretEnv",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/index:IntermediateStorageOptions"
+    },
     "@wbce/projen-d9.PackageVersions": {
       "assembly": "@wbce/projen-d9",
       "datatype": true,
@@ -509,12 +597,9 @@
         {
           "abstract": true,
           "docs": {
-            "custom": {
-              "ariga": "/atlas to use."
-            },
-            "default": "\"0.32.0\"",
+            "default": "\"1.3.3\"",
             "stability": "stable",
-            "summary": "The version of."
+            "summary": "The version of the Atlas binary downloaded by d9-plumbing."
           },
           "immutable": true,
           "locationInModule": {
@@ -545,8 +630,80 @@
         }
       ],
       "symbolId": "src/index:PackageVersions"
+    },
+    "@wbce/projen-d9.PlumbingOptions": {
+      "assembly": "@wbce/projen-d9",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Configuration of the d9-plumbing CLI, written to `d9-plumbing.json`."
+      },
+      "fqn": "@wbce/projen-d9.PlumbingOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/index.ts",
+        "line": 39
+      },
+      "name": "PlumbingOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"d9-plumbing-common\"",
+            "stability": "stable",
+            "summary": "Name of the d9 folder kept in the snapshot, overridden by the COMMON_FOLDER_NAME environment variable."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 54
+          },
+          "name": "commonFolderName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- none, the intermediate storage is configured with INTERMEDIATE_STORAGE_* variables or flags",
+            "stability": "stable",
+            "summary": "Storage shared between environments."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 44
+          },
+          "name": "intermediateStorage",
+          "optional": true,
+          "type": {
+            "fqn": "@wbce/projen-d9.IntermediateStorageOptions"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"debug\"",
+            "stability": "stable",
+            "summary": "Default log level of the CLI, overridden by the LOG_LEVEL environment variable."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 49
+          },
+          "name": "logLevel",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/index:PlumbingOptions"
     }
   },
-  "version": "0.0.28",
-  "fingerprint": "stO0Uf0VSXBrOUfqYAXqwJutNv9tV65u9ojcFxGDV7Q="
+  "version": "0.1.1",
+  "fingerprint": "UdroE5xwdxC/OxkjwYVkl7p1fO64s0rn2AAAgOVDgPU="
 }