@open-e2ee/oe 0.0.0-stage → 3.0.0

package/README.md

@@ -1,3 +1,21 @@
-# Temporary Holding Version
+# `@open-e2ee/oe`
 
-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.
+This package installs the `oe` command through an optional native package for
+the current operating system and CPU. It does not download a binary during
+installation.
+
+Run `oe auth login` to log in with a browser and accept the terms for the
+organization. Use `oe new` to create a project and its Sandbox environment,
+and `oe config push` to apply the environment sections of the config.
+
+`open-e2ee.config.ts` imports `defineConfig` and the config types from
+`@open-e2ee/oe/config`. `oe` reads the file with Node.js 22.18 or later, and
+the file loads without `node_modules`. Run `oe config pull` to write the Relay
+policy of each active environment from the console into the file.
+
+Run `oe help` for every command, its usage, the exit codes, and the environment
+variables. Under a coding agent, or with `--agent yes`, `oe` writes JSON by
+default: each run writes one JSON document to stdout with a stable `code` and,
+when there is one, the `next` command. Run
+`oe project connection --env sandbox` to print the Relay connection URL of an
+environment.

package/bin/oe.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+import { createRequire } from "node:module";
+import { spawnSync } from "node:child_process";
+
+const platformPackages = {
+  "darwin-arm64": "@open-e2ee/oe-darwin-arm64",
+  "darwin-x64": "@open-e2ee/oe-darwin-x64",
+  "linux-arm64": "@open-e2ee/oe-linux-arm64",
+  "linux-x64": "@open-e2ee/oe-linux-x64",
+  "win32-arm64": "@open-e2ee/oe-win32-arm64",
+  "win32-x64": "@open-e2ee/oe-win32-x64",
+};
+
+const require = createRequire(import.meta.url);
+const target = `${process.platform}-${process.arch}`;
+const packageName = platformPackages[target];
+
+if (!packageName) {
+  process.stderr.write(`OpenE2EE CLI does not support ${target}.\n`);
+  process.exit(1);
+}
+
+let binary;
+try {
+  binary =
+    process.env.OE_BINARY_PATH ||
+    require.resolve(
+      `${packageName}/bin/oe${process.platform === "win32" ? ".exe" : ""}`,
+    );
+} catch {
+  process.stderr.write(
+    `The optional package ${packageName} is missing. Reinstall @open-e2ee/oe with optional dependencies enabled.\n`,
+  );
+  process.exit(1);
+}
+
+const result = spawnSync(binary, process.argv.slice(2), { stdio: "inherit" });
+if (result.error) {
+  process.stderr.write(`Could not run OpenE2EE CLI: ${result.error.message}\n`);
+  process.exit(1);
+}
+process.exit(result.status ?? 1);

package/config/index.d.ts

@@ -0,0 +1,40 @@
+/** A retention period that the managed Relay accepts. */
+export type Retention =
+  "1h" | "6h" | "12h" | "1d" | "3d" | "7d" | "14d" | "30d";
+
+/** The products that a project config can name. */
+export type Product = "signal-relay";
+
+/** How long the Relay keeps undelivered messages and attachments. */
+export interface RelayPolicy {
+  deliveryRetention: Retention;
+  attachmentRetention: Retention;
+}
+
+/**
+ * One environment section. A field that the section leaves out takes the
+ * value of the shared `relay` policy. Sandbox accepts at most 7d.
+ */
+export interface Environment {
+  relay?: Partial<RelayPolicy>;
+}
+
+/** The default export of `open-e2ee.config.ts`. */
+export interface Config {
+  product: Product;
+  /** The project slug: lowercase letters, digits, and single hyphens. */
+  project: string;
+  /** The Relay policy that each environment shares. */
+  relay: RelayPolicy;
+  /**
+   * The environments that `oe` syncs. Add `production: {}` to put
+   * Production in the sync.
+   */
+  environments: {
+    sandbox: Environment;
+    production?: Environment;
+  };
+}
+
+/** Returns the project config unchanged, with its types checked. */
+export declare function defineConfig(config: Config): Config;

package/config/index.js

@@ -0,0 +1,7 @@
+// defineConfig returns the project config unchanged. The types are in
+// index.d.ts. oe reads the value that open-e2ee.config.ts exports as its
+// default, and it resolves this module to its own copy, so the file loads
+// without node_modules.
+export function defineConfig(config) {
+  return config;
+}

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "@open-e2ee/oe",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "3.0.0",
+  "description": "OpenE2EE project command-line interface",
+  "license": "Apache-2.0",
+  "type": "module",
+  "bin": {
+    "oe": "bin/oe.js"
+  },
+  "exports": {
+    "./bin/oe.js": "./bin/oe.js",
+    "./config": {
+      "types": "./config/index.d.ts",
+      "default": "./config/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "bin",
+    "config",
+    "README.md"
+  ],
+  "optionalDependencies": {
+    "@open-e2ee/oe-darwin-arm64": "3.0.0",
+    "@open-e2ee/oe-darwin-x64": "3.0.0",
+    "@open-e2ee/oe-linux-arm64": "3.0.0",
+    "@open-e2ee/oe-linux-x64": "3.0.0",
+    "@open-e2ee/oe-win32-arm64": "3.0.0",
+    "@open-e2ee/oe-win32-x64": "3.0.0"
+  },
+  "engines": {
+    "node": ">=22.18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/open-e2ee/oe.git"
+  }
+}