@haatlabs-core/cli 0.0.0-stage → 0.10.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Haatlabs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,96 @@
-# Temporary Holding Version
+# @haatlabs-core/cli
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`haatlabs`: writes a project's managed files from `@haatlabs-core/templates`, and makes new
+projects.
+
+## Install
+
+    pnpm add @haatlabs-core/cli --save-dev
+
+or, to make a new app: `npx @haatlabs-core/cli create <name> --domain <domain>`.
+
+## In a project
+
+Each project has `@haatlabs-core/cli` as a devDependency, at its platform version, and a
+`platform.json` that says what the templates need to know (name, domain, port series, apps,
+CSP lists, memory limits, shared services, and the paths it keeps as its own in
+`unmanaged`).
+
+    make sync          # pnpm exec haatlabs sync
+    make sync-check    # pnpm exec haatlabs sync --check
+
+- `sync` writes every managed file and records what it wrote in `.platform/managed.json`.
+  It refuses to overwrite a file edited since, naming it, and writes nothing then:
+  change the template in the platform, or list the path in `unmanaged`. `--force`
+  overwrites. It removes a file the templates no longer produce.
+- `sync --check` fails when a managed file differs from what the templates would write.
+- `pnpm-workspace.yaml` is managed only between `# platform:begin` and `# platform:end`;
+  the project's own lines go after the block.
+- After moving to a new platform version by hand: `pnpm install`, then `make sync`. The
+  upgrade pull requests the platform's release opens have done both.
+
+### `memory` in platform.json
+
+The stack's container limits and the Node processes' memory and concurrency, all optional
+except as defaulted. A small host might say:
+
+    "memory": { "api": "320m", "redis": "48m", "redisMaxMemory": "32mb", "nodeHeapMb": 128, "workerConcurrency": 2 }
+
+- `api` (default `512m`) and `redis` (default `256m`): the containers' memory limits.
+  `workerMemory` (default `1g`) is the worker's.
+- `redisMaxMemory` (default `128mb`): Redis's own maxmemory, which must be below the redis
+  limit (the copy Redis makes of itself while it rewrites its file needs the room). The
+  schema only refuses a value at or above the limit; leaving real headroom for that copy
+  is the project's job.
+- `nodeHeapMb`: a Node heap cap (`--max-old-space-size`) for the api and the worker, so
+  Node throws before Docker kills the container. It must be below the api limit and
+  `workerMemory`. Unset, Node keeps its own default.
+- `workerConcurrency`: the worker's `WORKER_CONCURRENCY`, which wins over the env file's.
+
+Without `memory`, nothing changes. A refused value fails `sync` with the field named.
+
+### `memory.cache`
+
+    "memory": { …, "cache": {} }
+
+A Redis of the environment's own for caches (`maxMemory` 8mb in a `limit` of 16m by
+default): `allkeys-lru`, nothing on disk, never the queues' Redis. The api and worker get
+`CACHE_REDIS_URL=redis://cache:6379`. `maxMemory` must be below `limit`.
+
+### The name
+
+Lowercase letters and digits, single hyphens between them, starting with a letter, 2 to 31
+characters (`haatlabs-api`). Postgres identifiers, Prometheus metrics and variable names take
+it with underscores (`nameSnake`: `haatlabs_api`, `HAATLABS_API_…`); everything else keeps the
+hyphen.
+
+## A new project
+
+    npx @haatlabs-core/cli create <name> --domain <domain> [--kind shopify|web] \
+      [--infra standalone|haatlabs] [--port-series <1-9>] [--into <directory>] [--no-install] [--no-git]
+
+- `--kind shopify` (the default): the api, worker, dashboard, the embedded Shopify app, the
+  administrators' dashboard, billing and plans. `--kind web`: the same without Shopify
+  (email sign-in, organizations, Stripe and Razorpay plans).
+- `--infra standalone` (the default): the app brings its own Postgres, Redis and Caddy
+  (HTTPS) and deploys to any Debian or Ubuntu server; it owns every file, `LICENSE` and
+  `NOTICE` (Apache-2.0) included, and needs no token. `--infra haatlabs`: one of our own apps,
+  on Haatlabs' hosts, with the managed files `haatlabs sync` keeps in step; it prints what to
+  add to the edge, the database and GitHub.
+
+`--port-series` (required with `--infra haatlabs`; 1 for a standalone app) picks the ports:
+`<series>X00` for the api and `<series>X01` for the worker (X: 1 prod, 2 staging, 3 dev,
+4 local); 4, 5 and 6 are taken by our own apps.
+
+### A browser extension of an app
+
+    npx @haatlabs-core/cli create <name> --kind extension --app-domain <domain> [--app-name <name>]
+
+A side panel for Chrome and Edge on `@haatlabs-core/extension-ui` and
+`@haatlabs-core/extension-kit`, signed in through the app's own connect page
+(`https://app.<domain>/connect/extension`, which hands the key over as `<app-name>.connected`;
+the app's name is the project's without `-extension` by default) and calling its API
+(`https://api.<domain>`). `make key` gives its id for the app's `CONNECTABLE_EXTENSION_IDS`;
+`make extension-zip` writes the Chrome Web Store (and Edge Add-ons) upload. Firefox's web pages
+cannot hand a key to an extension, so this sign-in is for Chrome and Edge; an app with its own
+OAuth server can sign an extension in on Firefox with the kit's `startOAuthPkce`.

package/dist/block.d.ts

@@ -0,0 +1,6 @@
+export declare const BEGIN = "# platform:begin";
+export declare const END = "# platform:end";
+/** The managed block of a file, markers included, or null when the file has none. */
+export declare function blockOf(text: string): string | null;
+/** The file with its block replaced; a new file, or one without markers, becomes the block alone. */
+export declare function withBlock(existing: string | null, block: string): string;

package/dist/block.js

@@ -0,0 +1,20 @@
+export const BEGIN = '# platform:begin';
+export const END = '# platform:end';
+/** The managed block of a file, markers included, or null when the file has none. */
+export function blockOf(text) {
+    const start = text.indexOf(`${BEGIN}\n`);
+    if (start === -1)
+        return null;
+    const end = text.indexOf(END, start);
+    if (end === -1)
+        return null;
+    return text.slice(start, end + END.length);
+}
+/** The file with its block replaced; a new file, or one without markers, becomes the block alone. */
+export function withBlock(existing, block) {
+    const current = existing === null ? null : blockOf(existing);
+    if (existing === null || current === null)
+        return `${block}\n`;
+    return existing.replace(current, () => block);
+}
+//# sourceMappingURL=block.js.map

package/dist/block.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"block.js","sourceRoot":"","sources":["../src/block.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,KAAK,GAAG,kBAAkB,CAAC;AACxC,MAAM,CAAC,MAAM,GAAG,GAAG,gBAAgB,CAAC;AAEpC,qFAAqF;AACrF,MAAM,UAAU,OAAO,CAAC,IAAY;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;IACzC,IAAI,KAAK,KAAK,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACrC,IAAI,GAAG,KAAK,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,SAAS,CAAC,QAAuB,EAAE,KAAa;IAC9D,MAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7D,IAAI,QAAQ,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,GAAG,KAAK,IAAI,CAAC;IAC/D,OAAO,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC"}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+import { parseArgs } from 'node:util';
+import { create, createExtension } from './create.js';
+import { INFRAS, KINDS } from './platform-json.js';
+import { sync } from './sync.js';
+const USAGE = `usage:
+  haatlabs sync [--check] [--force] [--dir <project>]
+  haatlabs create <name> --domain <domain> [--kind shopify|web] [--infra standalone|haatlabs] [--port-series <1-9>]
+                  [--into <directory>] [--no-install] [--no-git]
+  haatlabs create <name> --kind extension --app-domain <domain> [--app-name <name>]
+                  [--into <directory>] [--no-install] [--no-git]`;
+async function main(argv) {
+    const [command, ...rest] = argv;
+    if (command === 'sync') {
+        const { values } = parseArgs({
+            args: rest,
+            options: { check: { type: 'boolean' }, force: { type: 'boolean' }, dir: { type: 'string' } },
+        });
+        const result = await sync({
+            dir: values.dir ?? process.cwd(),
+            check: values.check,
+            force: values.force,
+        });
+        if (values.check) {
+            for (const problem of result.problems)
+                console.error(problem);
+            if (result.problems.length > 0) {
+                console.error('the managed files differ from the templates: run make sync');
+                return 1;
+            }
+            console.log('managed files match the templates');
+            return 0;
+        }
+        for (const path of result.written)
+            console.log(`wrote ${path}`);
+        for (const path of result.removed)
+            console.log(`removed ${path}`);
+        if (result.written.length + result.removed.length === 0)
+            console.log('managed files already up to date');
+        return 0;
+    }
+    if (command === 'create') {
+        const { values, positionals } = parseArgs({
+            args: rest,
+            allowPositionals: true,
+            allowNegative: true,
+            options: {
+                domain: { type: 'string' },
+                'port-series': { type: 'string' },
+                into: { type: 'string' },
+                kind: { type: 'string' },
+                infra: { type: 'string' },
+                'app-domain': { type: 'string' },
+                'app-name': { type: 'string' },
+                install: { type: 'boolean', default: true },
+                git: { type: 'boolean', default: true },
+            },
+        });
+        const [name] = positionals;
+        if (values.kind === 'extension') {
+            if (!name || !values['app-domain']) {
+                console.error(USAGE);
+                return 2;
+            }
+            await createExtension({
+                name,
+                appDomain: values['app-domain'],
+                ...(values['app-name'] ? { appName: values['app-name'] } : {}),
+                into: values.into ?? process.cwd(),
+                install: values.install,
+                git: values.git,
+            });
+            return 0;
+        }
+        const kind = values.kind ?? 'shopify';
+        const infra = values.infra ?? 'standalone';
+        if (!name ||
+            !values.domain ||
+            !KINDS.includes(kind) ||
+            !INFRAS.includes(infra)) {
+            console.error(USAGE);
+            return 2;
+        }
+        await create({
+            name,
+            domain: values.domain,
+            ...(values['port-series'] ? { portSeries: Number(values['port-series']) } : {}),
+            kind: kind,
+            infra: infra,
+            into: values.into ?? process.cwd(),
+            install: values.install,
+            git: values.git,
+        });
+        return 0;
+    }
+    console.error(USAGE);
+    return 2;
+}
+main(process.argv.slice(2)).then((code) => process.exit(code), (error) => {
+    console.error(error instanceof Error ? error.message : error);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,MAAM,KAAK,GAAG;;;;;iEAKmD,CAAC;AAElE,KAAK,UAAU,IAAI,CAAC,IAAc;IAChC,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAChC,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACvB,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;YAC3B,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;SAC7F,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC;YACxB,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE;YAChC,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,QAAQ;gBAAE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC9D,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC/B,OAAO,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;gBAC5E,OAAO,CAAC,CAAC;YACX,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;YACjD,OAAO,CAAC,CAAC;QACX,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO;YAAE,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;QAChE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAO;YAAE,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;QAClE,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;YACrD,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;QAClD,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACzB,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;YACxC,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;YACtB,aAAa,EAAE,IAAI;YACnB,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC1B,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACjC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACxB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACxB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACzB,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAChC,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC9B,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;gBAC3C,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;aACxC;SACF,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;QAC3B,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACnC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACrB,OAAO,CAAC,CAAC;YACX,CAAC;YACD,MAAM,eAAe,CAAC;gBACpB,IAAI;gBACJ,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC;gBAC/B,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9D,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE;gBAClC,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,GAAG,EAAE,MAAM,CAAC,GAAG;aAChB,CAAC,CAAC;YACH,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,SAAS,CAAC;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,YAAY,CAAC;QAC3C,IACE,CAAC,IAAI;YACL,CAAC,MAAM,CAAC,MAAM;YACd,CAAE,KAA2B,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC5C,CAAE,MAA4B,CAAC,QAAQ,CAAC,KAAK,CAAC,EAC9C,CAAC;YACD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,MAAM,CAAC;YACX,IAAI;YACJ,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/E,IAAI,EAAE,IAAY;YAClB,KAAK,EAAE,KAAc;YACrB,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE;YAClC,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,GAAG,EAAE,MAAM,CAAC,GAAG;SAChB,CAAC,CAAC;QACH,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,CAAC;AACX,CAAC;AAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAC9B,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAC5B,CAAC,KAAc,EAAE,EAAE;IACjB,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC9D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CACF,CAAC"}

package/dist/context.d.ts

@@ -0,0 +1,18 @@
+import type { PlatformConfig } from './platform-json.js';
+declare const ENVIRONMENTS: {
+    readonly prod: 1;
+    readonly staging: 2;
+    readonly dev: 3;
+    readonly local: 4;
+};
+export type Environment = keyof typeof ENVIRONMENTS;
+export type PortName = 'api' | 'worker' | 'web' | 'shopify' | 'admin';
+export interface TemplateContext {
+    vars: Record<string, string>;
+    conditions: Record<string, boolean>;
+}
+/** <series>X00 api, X01 worker, X10 web, X20 shopify, X30 admin; X is 1 prod, 2 staging, 3 dev, 4 local. */
+export declare function portsOf(config: PlatformConfig): Record<Environment, Record<PortName, number>>;
+/** The values and conditions a template is rendered with, for one project. */
+export declare function contextOf(config: PlatformConfig, extra?: Record<string, string>): TemplateContext;
+export {};

package/dist/context.js

@@ -0,0 +1,87 @@
+const ENVIRONMENTS = { prod: 1, staging: 2, dev: 3, local: 4 };
+/** <series>X00 api, X01 worker, X10 web, X20 shopify, X30 admin; X is 1 prod, 2 staging, 3 dev, 4 local. */
+export function portsOf(config) {
+    const result = {};
+    for (const [environment, digit] of Object.entries(ENVIRONMENTS)) {
+        const base = config.portSeries * 1000 + digit * 100;
+        result[environment] = {
+            api: base,
+            worker: base + 1,
+            web: base + 10,
+            shopify: base + 20,
+            admin: base + 30,
+            ...config.ports[environment],
+        };
+    }
+    return result;
+}
+/** The values and conditions a template is rendered with, for one project. */
+export function contextOf(config, extra = {}) {
+    // Postgres identifiers, Prometheus metric names and environment variables take no hyphen;
+    // everything else (Docker, npm, Redis, cookies, DNS) keeps the project's real name.
+    const nameSnake = config.name.replaceAll('-', '_');
+    const vars = {
+        name: config.name,
+        nameSnake,
+        Name: config.title ?? config.name.charAt(0).toUpperCase() + config.name.slice(1),
+        NAME: nameSnake.toUpperCase(),
+        domain: config.domain,
+        workerMemory: config.workerMemory,
+        'memory.api': config.memory.api,
+        'memory.redis': config.memory.redis,
+        'memory.redisMaxMemory': config.memory.redisMaxMemory,
+        'csp.connectSrc': config.csp.connectSrc.join(' '),
+        'csp.imgSrc': config.csp.imgSrc.join(' '),
+        'csp.connectSrcPrefixed': config.csp.connectSrc.map((source) => ` ${source}`).join(''),
+        'csp.imgSrcPrefixed': config.csp.imgSrc.map((source) => ` ${source}`).join(''),
+    };
+    // A new project's own containers on a laptop: clear of the ports the three first
+    // projects chose by hand, whatever its series.
+    const series = config.portSeries;
+    vars.portSeries = String(series);
+    vars['port.local.postgres'] = String(55029 + 100 * series);
+    vars['port.local.redis'] = String(64009 + 100 * series);
+    vars['port.local.cache'] = String(64019 + 100 * series);
+    vars['port.local.mail'] = String(8309 + 10 * series);
+    vars['port.local.smtp'] = String(10509 + 10 * series);
+    for (const [environment, ports] of Object.entries(portsOf(config))) {
+        for (const [name, value] of Object.entries(ports))
+            vars[`port.${environment}.${name}`] = String(value);
+    }
+    vars.combinedEnvs = config.combinedWorker.join(' ');
+    vars['memory.combinedApi'] = config.memory.combinedApi;
+    vars['memory.combinedHeapMb'] = String(config.memory.combinedHeapMb);
+    if (config.memory.nodeHeapMb !== undefined)
+        vars['memory.nodeHeapMb'] = String(config.memory.nodeHeapMb);
+    if (config.memory.workerConcurrency !== undefined) {
+        vars['memory.workerConcurrency'] = String(config.memory.workerConcurrency);
+    }
+    if (config.memory.cache) {
+        vars['memory.cache.maxMemory'] = config.memory.cache.maxMemory;
+        vars['memory.cache.limit'] = config.memory.cache.limit;
+    }
+    const image = config.sharedServices?.image;
+    if (image) {
+        vars.sharedImage = image;
+        vars.sharedImageVar = `${image.toUpperCase().replaceAll('-', '_')}_IMAGE`;
+    }
+    return {
+        vars: { ...vars, ...extra },
+        conditions: {
+            web: config.apps.includes('web'),
+            shopify: config.apps.includes('shopify'),
+            admin: config.apps.includes('admin'),
+            dashboards: ['web', 'shopify', 'admin'].some((app) => config.apps.includes(app)),
+            sharedServices: config.sharedServices !== undefined,
+            sharedImage: image !== undefined,
+            combinedWorker: config.combinedWorker.length > 0,
+            registryGithub: config.registry === 'github',
+            nodeHeap: config.memory.nodeHeapMb !== undefined,
+            workerConcurrency: config.memory.workerConcurrency !== undefined,
+            cache: config.memory.cache !== undefined,
+            standalone: config.infra === 'standalone',
+            kindShopify: config.kind === 'shopify',
+        },
+    };
+}
+//# sourceMappingURL=context.js.map

package/dist/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAEA,MAAM,YAAY,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAW,CAAC;AASxE,4GAA4G;AAC5G,MAAM,UAAU,OAAO,CAAC,MAAsB;IAC5C,MAAM,MAAM,GAAG,EAAmD,CAAC;IACnE,KAAK,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAA4B,EAAE,CAAC;QAC3F,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,GAAG,IAAI,GAAG,KAAK,GAAG,GAAG,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,GAAG;YACpB,GAAG,EAAE,IAAI;YACT,MAAM,EAAE,IAAI,GAAG,CAAC;YAChB,GAAG,EAAE,IAAI,GAAG,EAAE;YACd,OAAO,EAAE,IAAI,GAAG,EAAE;YAClB,KAAK,EAAE,IAAI,GAAG,EAAE;YAChB,GAAG,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;SAC7B,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,SAAS,CACvB,MAAsB,EACtB,QAAgC,EAAE;IAElC,0FAA0F;IAC1F,oFAAoF;IACpF,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACnD,MAAM,IAAI,GAA2B;QACnC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,SAAS;QACT,IAAI,EAAE,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAChF,IAAI,EAAE,SAAS,CAAC,WAAW,EAAE;QAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG;QAC/B,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK;QACnC,uBAAuB,EAAE,MAAM,CAAC,MAAM,CAAC,cAAc;QACrD,gBAAgB,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC;QACjD,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QACzC,wBAAwB,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QACtF,oBAAoB,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;KAC/E,CAAC;IACF,iFAAiF;IACjF,+CAA+C;IAC/C,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC;IACjC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,qBAAqB,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC;IAC3D,IAAI,CAAC,kBAAkB,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC;IACxD,IAAI,CAAC,kBAAkB,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC;IACxD,IAAI,CAAC,iBAAiB,CAAC,GAAG,MAAM,CAAC,IAAI,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC;IACrD,IAAI,CAAC,iBAAiB,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC;IACtD,KAAK,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QACnE,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;YAC/C,IAAI,CAAC,QAAQ,WAAW,IAAI,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,IAAI,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;IACvD,IAAI,CAAC,uBAAuB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACrE,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;QACxC,IAAI,CAAC,mBAAmB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC/D,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QAClD,IAAI,CAAC,0BAA0B,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAC7E,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,CAAC,wBAAwB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;QAC/D,IAAI,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IACzD,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC;IAC3C,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC;IAC5E,CAAC;IACD,OAAO;QACL,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,EAAE;QAC3B,UAAU,EAAE;YACV,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAChC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;YACxC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YACpC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAU,CAAC,CAAC;YACvF,cAAc,EAAE,MAAM,CAAC,cAAc,KAAK,SAAS;YACnD,WAAW,EAAE,KAAK,KAAK,SAAS;YAChC,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;YAChD,cAAc,EAAE,MAAM,CAAC,QAAQ,KAAK,QAAQ;YAC5C,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;YAChD,iBAAiB,EAAE,MAAM,CAAC,MAAM,CAAC,iBAAiB,KAAK,SAAS;YAChE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS;YACxC,UAAU,EAAE,MAAM,CAAC,KAAK,KAAK,YAAY;YACzC,WAAW,EAAE,MAAM,CAAC,IAAI,KAAK,SAAS;SACvC;KACF,CAAC;AACJ,CAAC"}

package/dist/create.d.ts

@@ -0,0 +1,67 @@
+import type { Infra, Kind } from './platform-json.js';
+export interface CreateOptions {
+    name: string;
+    domain: string;
+    /**
+     * The project's port series (1 to 9), which keeps our own apps apart on shared hosts. A
+     * standalone app has a server of its own: 1 unless given. Required with `infra: haatlabs`.
+     */
+    portSeries?: number;
+    /** The directory the project's own directory is made in. */
+    into: string;
+    /** A Shopify app (the default) or a plain web app. */
+    kind?: Kind;
+    /** Its own Postgres, Redis and proxy (the default), or Haatlabs' hosts with `haatlabs sync`. */
+    infra?: Infra;
+    /**
+     * Where the app installs the platform from. Default: the registry this CLI itself came
+     * from (ownRegistry), so `npx @haatlabs-core/cli create` makes an app that needs no token.
+     */
+    registry?: 'github' | 'npm';
+    /** Installs the dependencies, which writes pnpm-lock.yaml. */
+    install?: boolean;
+    /** Makes the directory a git repository with one commit. */
+    git?: boolean;
+    log?: (line: string) => void;
+}
+/**
+ * The registry a package of the platform came from: the npm copy says so in its own
+ * package.json (`platformRegistry: "npm"`, written when it is published); ours says nothing.
+ * Never read from the package's name: the npm copy's code is the same code, renamed.
+ */
+export declare function ownRegistry(pkg: {
+    platformRegistry?: string;
+}): 'github' | 'npm';
+/**
+ * Whether a template file is written executable. npm and pnpm pack every file but a bin as
+ * 0644, so an installed template has lost its mode: a shell script is executable by its name.
+ */
+export declare function executableTemplate(path: string, mode: number): boolean;
+/**
+ * A new project with everything the platform's apps have: the starter, rendered for its
+ * name, series and domain, then every managed file (`haatlabs sync`). Returns its directory.
+ */
+export declare function create(options: CreateOptions): Promise<string>;
+export interface CreateExtensionOptions {
+    /** The extension project's name, such as `acme-extension`. */
+    name: string;
+    /** The app's domain: its dashboard is https://app.<domain>, its API https://api.<domain>. */
+    appDomain: string;
+    /**
+     * The app's own name, which its connect page sends the key with (`<app>.connected`); by
+     * default the project's name without `-extension`.
+     */
+    appName?: string;
+    /** Where its @haatlabs-core packages come from: by default, where this CLI came from. */
+    registry?: 'github' | 'npm';
+    into: string;
+    install?: boolean;
+    git?: boolean;
+    log?: (line: string) => void;
+}
+/**
+ * A browser extension of an app made on the platform: a side panel that signs in through the
+ * app's connect page and calls its API (`@haatlabs-core/extension-ui`, `@haatlabs-core/extension-kit`).
+ * It owns its files; there is no platform.json and no sync. Returns its directory.
+ */
+export declare function createExtension(options: CreateExtensionOptions): Promise<string>;