@trycourier/cli 2.7.1 → 3.1.4

package/install.js

@@ -0,0 +1,115 @@
+#!/usr/bin/env node
+
+"use strict";
+
+const https = require("https");
+const http = require("http");
+const fs = require("fs");
+const path = require("path");
+const { execSync } = require("child_process");
+
+const REPO = "trycourier/courier-cli";
+const VERSION = require("./package.json").version;
+const BIN_DIR = path.join(__dirname, "bin");
+
+const PLATFORM_MAP = {
+  "darwin-arm64": { archive: `courier_${VERSION}_macos_arm64.zip`, binary: "courier" },
+  "darwin-x64": { archive: `courier_${VERSION}_macos_amd64.zip`, binary: "courier" },
+  "linux-x64": { archive: `courier_${VERSION}_linux_amd64.tar.gz`, binary: "courier" },
+  "linux-arm64": { archive: `courier_${VERSION}_linux_arm64.tar.gz`, binary: "courier" },
+  "linux-ia32": { archive: `courier_${VERSION}_linux_386.tar.gz`, binary: "courier" },
+  "linux-arm": { archive: `courier_${VERSION}_linux_armv6.tar.gz`, binary: "courier" },
+  "win32-x64": { archive: `courier_${VERSION}_windows_amd64.zip`, binary: "courier.exe" },
+  "win32-arm64": { archive: `courier_${VERSION}_windows_arm64.zip`, binary: "courier.exe" },
+  "win32-ia32": { archive: `courier_${VERSION}_windows_386.zip`, binary: "courier.exe" },
+};
+
+const key = `${process.platform}-${process.arch}`;
+const target = PLATFORM_MAP[key];
+
+if (!target) {
+  console.error(
+    `Unsupported platform: ${key}\n` +
+    `Supported: ${Object.keys(PLATFORM_MAP).join(", ")}\n` +
+    `You can download the binary directly from:\n` +
+    `  https://github.com/${REPO}/releases/tag/v${VERSION}`
+  );
+  process.exit(1);
+}
+
+const url = `https://github.com/${REPO}/releases/download/v${VERSION}/${target.archive}`;
+const archivePath = path.join(BIN_DIR, target.archive);
+
+function follow(requestUrl, redirects) {
+  if (redirects > 10) {
+    throw new Error("Too many redirects");
+  }
+  return new Promise((resolve, reject) => {
+    const lib = requestUrl.startsWith("https") ? https : http;
+    lib.get(requestUrl, { headers: { "User-Agent": `@trycourier/cli-npm/${VERSION}` } }, (res) => {
+      if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+        resolve(follow(res.headers.location, redirects + 1));
+        return;
+      }
+      if (res.statusCode !== 200) {
+        reject(new Error(`Download failed: HTTP ${res.statusCode} from ${requestUrl}`));
+        return;
+      }
+      resolve(res);
+    }).on("error", reject);
+  });
+}
+
+async function download() {
+  console.log(`Downloading Courier CLI v${VERSION} for ${key}...`);
+
+  const res = await follow(url, 0);
+  const file = fs.createWriteStream(archivePath);
+  await new Promise((resolve, reject) => {
+    res.pipe(file);
+    file.on("finish", () => { file.close(resolve); });
+    file.on("error", reject);
+  });
+}
+
+function extract() {
+  const binPath = path.join(BIN_DIR, target.binary);
+
+  if (target.archive.endsWith(".tar.gz")) {
+    execSync(`tar -xzf "${archivePath}" -C "${BIN_DIR}" "${target.binary}"`, { stdio: "pipe" });
+  } else if (target.archive.endsWith(".zip")) {
+    if (process.platform === "win32") {
+      execSync(
+        `powershell -Command "Expand-Archive -Force '${archivePath}' '${BIN_DIR}'"`,
+        { stdio: "pipe" }
+      );
+    } else {
+      execSync(`unzip -o -j "${archivePath}" "${target.binary}" -d "${BIN_DIR}"`, { stdio: "pipe" });
+    }
+  }
+
+  if (process.platform !== "win32") {
+    fs.chmodSync(binPath, 0o755);
+  }
+
+  fs.unlinkSync(archivePath);
+
+  console.log(`Courier CLI v${VERSION} installed successfully.`);
+}
+
+async function main() {
+  try {
+    fs.mkdirSync(BIN_DIR, { recursive: true });
+    await download();
+    extract();
+  } catch (err) {
+    console.error(
+      `Failed to install Courier CLI: ${err.message}\n` +
+      `You can download the binary manually from:\n` +
+      `  https://github.com/${REPO}/releases/tag/v${VERSION}`
+    );
+    process.exit(1);
+  }
+}
+
+main();

package/package.json

@@ -1,89 +1,24 @@
 {
-	"name": "@trycourier/cli",
-	"version": "2.7.1",
-	"license": "MIT",
-	"bin": {
-		"courier": "dist/cli.js"
-	},
-	"type": "module",
-	"engines": {
-		"node": ">=20"
-	},
-	"scripts": {
-		"build": "tsc",
-		"dev": "tsc --watch",
-		"test": "prettier --check . && xo && ava",
-		"format": "prettier --write .",
-		"clean": "rm -rf dist && rm -rf node_modules && yarn install"
-	},
-	"files": [
-		"dist"
-	],
-	"dependencies": {
-		"@babel/runtime": "^7.24.7",
-		"@inkjs/ui": "^2.0.0",
-		"@trycourier/client-graphql": "^6.0.0",
-		"@trycourier/core": "^6.0.0",
-		"@trycourier/courier": "^6.2.1",
-		"cli-spinners": "^3.0.0",
-		"csv-stringify": "^6.5.0",
-		"dotenv": "^16.0.3",
-		"duckdb": "^1.0.0",
-		"execa": "^9.1.0",
-		"ink": "^5.0.1",
-		"ink-link": "^4.0.0",
-		"ink-spinner": "^5.0.0",
-		"lodash": "^4.17.21",
-		"luxon": "^3.4.4",
-		"ms": "3.0.0-canary.1",
-		"react": "^18.2.0",
-		"usehooks-ts": "^3.1.0",
-		"yargs-parser": "^21.1.1"
-	},
-	"devDependencies": {
-		"@sindresorhus/tsconfig": "^5.0.0",
-		"@types/lodash": "^4.17.4",
-		"@types/luxon": "^3.4.2",
-		"@types/node": "^20.13.0",
-		"@types/react": "^18.0.32",
-		"@types/yargs-parser": "^21.0.0",
-		"@vdemedes/prettier-config": "^2.0.1",
-		"ava": "^5.2.0",
-		"chalk": "^5.2.0",
-		"eslint-config-xo-react": "^0.27.0",
-		"eslint-plugin-react": "^7.32.2",
-		"eslint-plugin-react-hooks": "^4.6.0",
-		"ink-testing-library": "^3.0.0",
-		"prettier": "^2.8.7",
-		"ts-node": "^10.9.1",
-		"typescript": "^5.4.5",
-		"xo": "^0.53.1"
-	},
-	"ava": {
-		"extensions": {
-			"ts": "module",
-			"tsx": "module"
-		},
-		"nodeArguments": [
-			"--loader=ts-node/esm"
-		]
-	},
-	"xo": {
-		"extends": "xo-react",
-		"prettier": true,
-		"rules": {
-			"react/prop-types": "off"
-		}
-	},
-	"prettier": "@vdemedes/prettier-config",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/trycourier/courier-cli.git"
-	},
-	"publishConfig": {
-		"access": "public",
-		"registry": "https://registry.npmjs.org/"
-	},
-	"homepage": "https://github.com/trycourier/courier-cli#readme",
-	"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+  "name": "@trycourier/cli",
+  "version": "3.1.4",
+  "description": "Courier CLI – manage notifications from the command line",
+  "bin": {
+    "courier": "./bin/courier"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
+  },
+  "files": [
+    "bin/",
+    "install.js"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/trycourier/courier-cli.git"
+  },
+  "homepage": "https://github.com/trycourier/courier-cli",
+  "engines": {
+    "node": ">=14"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Courier
-
-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

@@ -1,105 +0,0 @@
-# Courier CLI
-
-### Build, test, and manage your [Courier](https://www.courier.com) integration directly from the command line.
-
-The Courier CLI is a developer tool to help you build, test, and manage your integration with Courier directly from the command line. It’s simple to install, works on macOS, Windows, and Linux, and offers a range of functionality to enhance your developer experience with Courier. You can use the Courier CLI to:
-
-- Send messages from the command line to users, lists, or audiences
-- Track events to trigger your Courier Automations
-- Push & pull industry-standard translation files for internationalizing your content
-
-## Installing the Courier CLI
-
-From the command-line, use the following command to install the Courier CLI and set your API key:
-
-```bash
-$ yarn install -g @trycourier/cli
-$ courier config --apikey <your-api-key>
-```
-
-### Requirements
-
-- Courier CLI has only been tested on node.js v18+
-
-## Authenticate the CLI
-
-The fastest way to get started is to run:
-
-```
-$ courier config --apikey <your-api-key>
-```
-
-Courier CLI looks for environment variables prefixed with `COURIER_AUTH_TOKEN`. It will load keys from the first location it finds in the following list:
-
-- A `.courier` file in the current working directory
-- `~/.courier` (in your home directory)
-- A `COURIER_AUTH_TOKEN` or `COURIER_AUTH_TOKEN_*` value otherwise set in your environment (such as via `~/.profile` or `~/.zshrc`)
-
-You can find your Courier API key in your [Courier Settings](https://app.courier.com/settings/api-keys).
-
-## Commands
-
-- `courier config` – Set your Courier API key
-- `courier whoami` – Display the currently authenticated workspace
-- `courier send` - Send a notification to a user, list, tenant, or audience
-- `courier track` - Send a track event to trigger a Courier Automations
-- `courier users:get` - Fetch the data for a given user ID
-- `courier users:set` - Overwrite a user's profile with the provided data
-- `courier users:bulk` - Bulk upload users via csv, json, or parquet
-- `courier translations:upload` - Upload .PO files to your Courier workspace
-- `courier translations:download` - Download .PO files from your Courier workspace
-
-For more details, run `courier` to see a list of commands and their arguments & options.
-
-## Examples
-
-```
-courier --help
-courier --version
-courier upgrade
-
-courier send --tel 555-867-5309 --body "Hey Jenny\!"
-courier send --user user123 --template my-template-id --foo bar
-courier send -P --user=test123 --body "hello world" --title="hello" --channels=inbox
-courier send --tenant=kewl --title=hello --body="hello world" --channel=inbox
-courier send --user="1" --tenant-context=kewl --title=hello --body="hello world" --channel=inbox
-
-courier users:get user123
-courier users:set user123 --email user@example.com
-courier users:bulk examples/users.csv --replace
-courier users:bulk examples/users.parquet --list new-list-id --tenant new-tenant-id
-
-courier track EXAMPLE_EVENT user123 --name "Pip the Pigeon"
-
-courier translations:upload en-US ./translations/en-US.po
-courier translations:download en-US --text > example.en-US.po
-
-courier config --apikey MY_API_KEY -P --override
-courier config --apikey MY_API_KEY --mock
-courier config --apikey MY_API_KEY --draft
-```
-
-## Common Flags
-
-There are a number flags you can use for any command
-
-| Flags                      | Description                                                                                                              |
-| -------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| -M --mock                  | Use the API key that simulates sending using the simulating routing                                                      |
-| -P --production            | Use the production environment API key                                                                                   |
-| -D --draft                 | Use the draft document scope API key. Use draft or submitted, will default to published key if neither are provided      |
-| -S --submitted             | Use the submitted document scope API key                                                                                 |
-| --apikey <Courier API Key> | Use the provided Courier API key, otherwise use the approprate environment variable                                      |
-| --apiurl <Courier API URL> | Use the provided Courier API URL, otherwise use COURIER_API_URL environment variable. Default is https://api.courier.com |
-
-## Misc
-
-- If you need to change the Courier API URL, you can set COURIER_API_URL in .courier or other methods to set the environment variables.
-
-## License
-
-[MIT License](http://www.opensource.org/licenses/mit-license.php)
-
-## Author
-
-[Courier](https://github.com/trycourier) ([support@courier.com](mailto:support@courier.com))

package/dist/bulk.d.ts

@@ -1,15 +0,0 @@
-import duckdb from 'duckdb';
-export declare const installExtension: (db: duckdb.Database, type?: TFileType) => void;
-export declare const getFrom: (filename: string, type: TFileType) => string;
-export declare const getFileType: (filename: string) => TFileType | undefined;
-export declare const getSql: (filename: string, type: TFileType) => string;
-declare const getDb: (filename: string) => {
-    db: duckdb.Database;
-    filetype: TFileType | undefined;
-    sql: string;
-};
-export declare const getChunk: (data: duckdb.TableData, chunk_size?: number) => {
-    rows: duckdb.RowData[];
-    data: duckdb.TableData;
-};
-export default getDb;

package/dist/bulk.js

@@ -1,53 +0,0 @@
-import duckdb from 'duckdb';
-export const installExtension = (db, type) => {
-    if (['json', 'parquet'].includes(type || '')) {
-        db.exec(`
-            INSTALL ${type};
-            LOAD ${type};`);
-    }
-};
-export const getFrom = (filename, type) => {
-    switch (type) {
-        case 'csv':
-            return `read_csv(['${filename}'], union_by_name = true)`;
-        case 'json':
-            return `read_json_auto(['${filename}'])`;
-        case 'parquet':
-            return `read_parquet(['${filename}'])`;
-    }
-};
-export const getFileType = (filename) => {
-    if (filename.endsWith('.csv')) {
-        return 'csv';
-    }
-    else if (filename.endsWith('.json') || filename.endsWith('.jsonl')) {
-        return 'json';
-    }
-    else if (filename.endsWith('.parquet') ||
-        filename.endsWith('.pq') ||
-        filename.endsWith('.parq')) {
-        return 'parquet';
-    }
-    else {
-        return undefined;
-    }
-};
-export const getSql = (filename, type) => `SELECT * FROM ${getFrom(filename, type)} ;`;
-const getDb = (filename) => {
-    const filetype = getFileType(filename);
-    const db = new duckdb.Database(':memory:'); // or a file name for a persistent DB
-    installExtension(db, filetype);
-    return {
-        db,
-        filetype,
-        sql: getSql(filename, filetype || 'csv'),
-    };
-};
-export const getChunk = (data, chunk_size = 1) => {
-    let rows = data.splice(0, chunk_size);
-    return {
-        rows,
-        data
-    };
-};
-export default getDb;

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -1,24 +0,0 @@
-#!/usr/bin/env node
-import { render } from 'ink';
-import React from 'react';
-import { CliContextProvider } from './components/Context.js';
-import args from './lib/args.js';
-import loadEnv from './lib/load-env.js';
-import Version from './components/Version.js';
-// @ts-ignore
-BigInt.prototype.toJSON = function () {
-    return this.toString();
-};
-const CLI = async () => {
-    process.removeAllListeners('warning');
-    await loadEnv();
-    const params = args(process.argv);
-    const mappings = (await import('./mappings.js')).default;
-    const Router = (await import('./components/Router.js')).default;
-    render(React.createElement(CliContextProvider, { args: params, mappings },
-        React.createElement(Router, null),
-        React.createElement(Version, null)));
-};
-(async () => {
-    await CLI();
-})();

package/dist/commands/AudienceSearch.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const AudienceSearch: () => React.JSX.Element;
-export default AudienceSearch;

package/dist/commands/AudienceSearch.js

@@ -1,113 +0,0 @@
-import { Alert } from '@inkjs/ui';
-import { stringify } from 'csv-stringify/sync';
-import fs from 'fs/promises';
-import _ from 'lodash';
-import { DateTime } from 'luxon';
-import React, { useEffect, useState } from 'react';
-import { useBoolean, useCounter } from 'usehooks-ts';
-import { useCliContext } from '../components/Context.js';
-import Spinner from '../components/Spinner.js';
-import UhOh from '../components/UhOh.js';
-const FILENAME = 'audiences';
-const AudienceSearch = () => {
-    const { parsedParams, courier } = useCliContext();
-    const processing = useBoolean(true);
-    const running = useBoolean(true);
-    const counter = useCounter(0);
-    const [audiences, setAudiences] = useState([]);
-    const [error, setError] = useState();
-    const { maxPages, json, csv, webhook, filename, name, id } = parsedParams;
-    const out_file = (filename?.length
-        ? filename.substring(0, filename.includes('.') ? filename.lastIndexOf('.') : filename.length)
-        : FILENAME) + (csv ? '.csv' : '.json');
-    const MAX_PAGES = Number(maxPages) || 10;
-    useEffect(() => {
-        if (!processing.value) {
-            if (json || csv || webhook?.length) {
-                runExport();
-            }
-            else {
-                running.setFalse();
-            }
-        }
-    }, [processing.value]);
-    useEffect(() => {
-        getAudiences();
-    }, []);
-    const getAudiences = async (cursor, count = 0) => {
-        counter.increment();
-        const r = await courier.audiences.listAudiences({
-            cursor,
-        });
-        let items = r.items;
-        if (name) {
-            items = items.filter(a => a.name.includes(name));
-        }
-        if (id) {
-            items = items.filter(a => a.id.includes(id));
-        }
-        setAudiences(p => [...p, ...items]);
-        if (r.paging.more && count < MAX_PAGES) {
-            await getAudiences(r.paging.cursor, count + 1);
-        }
-        else {
-            processing.setFalse();
-        }
-    };
-    const runExport = async () => {
-        const flat = csv ? flattenData(audiences) : audiences;
-        if (csv) {
-            await fs.writeFile(out_file, stringify(flat, { header: true }));
-        }
-        else if (json) {
-            await fs.writeFile(out_file, JSON.stringify(flat, null, 2), {
-                encoding: 'utf-8',
-            });
-        }
-        if (webhook?.length) {
-            try {
-                await fetch(webhook, {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                    },
-                    body: JSON.stringify(flat),
-                });
-            }
-            catch (e) {
-                setError(e instanceof Error ? e.message : String(e));
-            }
-        }
-        running.setFalse();
-    };
-    if (error?.length) {
-        return React.createElement(UhOh, { text: error });
-    }
-    else if (running.value) {
-        return React.createElement(Spinner, { text: `Fetching audiences - page ${counter.count}` });
-    }
-    else {
-        return (React.createElement(React.Fragment, null,
-            React.createElement(Alert, { variant: "success", title: `Finished ${counter.count} pages` }, csv || json
-                ? `Output ${audiences.length} audiences to ${out_file}`
-                : JSON.stringify(audiences, null, 2))));
-    }
-};
-const flattenData = (data) => {
-    return data.map(row => {
-        return Object.keys(row).reduce((p, key) => {
-            const v = _.get(row, [key]);
-            if (typeof v === 'number') {
-                p[key] = DateTime.fromMillis(v, { zone: 'utc' }).toISO();
-            }
-            else if (typeof v === 'object') {
-                p[key] = JSON.stringify(v);
-            }
-            else if (v) {
-                p[key] = v;
-            }
-            return p;
-        }, {});
-    });
-};
-export default AudienceSearch;

package/dist/commands/AutomationInvokeBulk.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-declare const AutomationInvokeBulk: () => React.JSX.Element;
-export default AutomationInvokeBulk;