emailr 0.2.0 → 1.0.1

package/package.json

@@ -1,126 +1,40 @@
 {
   "name": "emailr",
-  "version": "0.2.0",
-  "author": "Speakeasy",
-  "type": "module",
-  "tshy": {
-    "sourceDialects": [
-      "emailr/source"
-    ],
-    "exports": {
-      ".": "./src/index.ts",
-      "./package.json": "./package.json",
-      "./types": "./src/types/index.ts",
-      "./models/errors": "./src/models/errors/index.ts",
-      "./models": "./src/models/index.ts",
-      "./models/operations": "./src/models/operations/index.ts",
-      "./*.js": "./src/*.ts",
-      "./*": "./src/*.ts"
+  "version": "1.0.1",
+  "description": "Official Emailr API SDK for TypeScript/JavaScript",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     }
   },
-  "sideEffects": false,
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/emailr-dev/emailr-typescript.git"
-  },
-  "scripts": {
-    "lint": "eslint --cache --max-warnings=0 src",
-    "build": "tshy",
-    "prepublishOnly": "npm run build"
-  },
-  "peerDependencies": {},
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "emailr",
+    "email",
+    "api",
+    "sdk",
+    "typescript"
+  ],
+  "author": "Emailr",
+  "license": "MIT",
   "devDependencies": {
-    "@eslint/js": "^9.19.0",
-    "eslint": "^9.19.0",
-    "globals": "^15.14.0",
-    "tshy": "^2.0.0",
-    "typescript": "~5.8.3",
-    "typescript-eslint": "^8.26.0"
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.2.0"
   },
-  "dependencies": {
-    "zod": "^3.25.65 || ^4.0.0"
+  "engines": {
+    "node": ">=18.0.0"
   },
-  "exports": {
-    ".": {
-      "import": {
-        "emailr/source": "./src/index.ts",
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    },
-    "./package.json": "./package.json",
-    "./types": {
-      "import": {
-        "emailr/source": "./src/types/index.ts",
-        "types": "./dist/esm/types/index.d.ts",
-        "default": "./dist/esm/types/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/types/index.d.ts",
-        "default": "./dist/commonjs/types/index.js"
-      }
-    },
-    "./models/errors": {
-      "import": {
-        "emailr/source": "./src/models/errors/index.ts",
-        "types": "./dist/esm/models/errors/index.d.ts",
-        "default": "./dist/esm/models/errors/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/models/errors/index.d.ts",
-        "default": "./dist/commonjs/models/errors/index.js"
-      }
-    },
-    "./models": {
-      "import": {
-        "emailr/source": "./src/models/index.ts",
-        "types": "./dist/esm/models/index.d.ts",
-        "default": "./dist/esm/models/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/models/index.d.ts",
-        "default": "./dist/commonjs/models/index.js"
-      }
-    },
-    "./models/operations": {
-      "import": {
-        "emailr/source": "./src/models/operations/index.ts",
-        "types": "./dist/esm/models/operations/index.d.ts",
-        "default": "./dist/esm/models/operations/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/models/operations/index.d.ts",
-        "default": "./dist/commonjs/models/operations/index.js"
-      }
-    },
-    "./*.js": {
-      "import": {
-        "emailr/source": "./src/*.ts",
-        "types": "./dist/esm/*.d.ts",
-        "default": "./dist/esm/*.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/*.d.ts",
-        "default": "./dist/commonjs/*.js"
-      }
-    },
-    "./*": {
-      "import": {
-        "emailr/source": "./src/*.ts",
-        "types": "./dist/esm/*.d.ts",
-        "default": "./dist/esm/*.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/*.d.ts",
-        "default": "./dist/commonjs/*.js"
-      }
-    }
-  },
-  "main": "./dist/commonjs/index.js",
-  "types": "./dist/commonjs/index.d.ts",
-  "module": "./dist/esm/index.js"
-}
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/.devcontainer/devcontainer.json

@@ -1,45 +0,0 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node
-{
-    "name": "TypeScript",
-    "image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
-    // Features to add to the dev container. More info: https://containers.dev/features.
-    // "features": {},
-    // Use 'forwardPorts' to make a list of ports inside the container available locally.
-    // "forwardPorts": [],
-    // Use 'postCreateCommand' to run commands after the container is created.
-    "postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
-    "customizations": {
-        "vscode": {
-            "extensions": [
-                "ms-vscode.vscode-typescript-tslint-plugin",
-                "esbenp.prettier-vscode",
-                "github.vscode-pull-request-github"
-            ],
-            "settings": {
-                "files.eol": "\n",
-                "editor.formatOnSave": true,
-                "typescript.tsc.autoDetect": "on",
-                "typescript.updateImportsOnFileMove.enabled": "always",
-                "typescript.preferences.importModuleSpecifier": "relative",
-                "[typescript]": {
-                    "editor.codeActionsOnSave": {
-                        "source.organizeImports": true
-                    }
-                },
-                "[typescriptreact]": {
-                    "editor.codeActionsOnSave": {
-                        "source.organizeImports": true
-                    }
-                }
-            }
-        },
-        "codespaces": {
-            "openFiles": [
-                ".devcontainer/README.md"
-            ]
-        }
-    }
-    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-    // "remoteUser": "root"
-}

package/FUNCTIONS.md

@@ -1,114 +0,0 @@
-# Standalone Functions
-
-> [!NOTE]
-> This section is useful if you are using a bundler and targetting browsers and
-> runtimes where the size of an application affects performance and load times. 
-
-Every method in this SDK is also available as a standalone function. This
-alternative API is suitable when targetting the browser or serverless runtimes
-and using a bundler to build your application since all unused functionality
-will be tree-shaken away. This includes code for unused methods, Zod schemas,
-encoding helpers and response handlers. The result is dramatically smaller
-impact on the application's final bundle size which grows very slowly as you use
-more and more functionality from this SDK.
-
-Calling methods through the main SDK class remains a valid and generally more
-more ergonomic option. Standalone functions represent an optimisation for a
-specific category of applications.
-
-## Example
-
-```typescript
-import { EmailrCore } from "emailr/core.js";
-import { emailsSend } from "emailr/funcs/emailsSend.js";
-
-// Use `EmailrCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const emailr = new EmailrCore({
-  bearerAuth: process.env["EMAILR_BEARER_AUTH"] ?? "",
-});
-
-async function run() {
-  const res = await emailsSend(emailr, {
-    from: "sender@example.com",
-    to: "recipient@example.com",
-    subject: "Hello World",
-    html: "<h1>Hello</h1>",
-    text: "Hello",
-    templateId: "123e4567-e89b-12d3-a456-426614174000",
-    templateData: {
-      "name": "John",
-      "company": "Acme",
-    },
-    tags: {
-      "campaign": "welcome",
-      "source": "signup",
-    },
-    attachments: [
-      {
-        filename: "document.pdf",
-        content: "JVBERi0xLjQKJe...",
-        contentType: "application/pdf",
-      },
-    ],
-    replyTo: {
-      inReplyTo: "<message-id@domain.com>",
-      threadId: "123e4567-e89b-12d3-a456-426614174000",
-      parentEmailId: "123e4567-e89b-12d3-a456-426614174000",
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("emailsSend failed:", res.error);
-  }
-}
-
-run();
-```
-
-## Result types
-
-Standalone functions differ from SDK methods in that they return a
-`Result<Value, Error>` type to capture _known errors_ and document them using
-the type system. By avoiding throwing errors, application code maintains clear
-control flow and error-handling become part of the regular flow of application
-code.
-
-> We use the term "known errors" because standalone functions, and JavaScript
-> code in general, can still throw unexpected errors such as `TypeError`s,
-> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
-> something this SDK addresses in the future. Nevertheless, there is still a lot
-> of benefit from capturing most errors and turning them into values.
-
-The second reason for this style of programming is because these functions will
-typically be used in front-end applications where exception throwing is
-sometimes discouraged or considered unidiomatic. React and similar ecosystems
-and libraries tend to promote this style of programming so that components
-render useful content under all states (loading, success, error and so on).
-
-The general pattern when calling standalone functions looks like this:
-
-```typescript
-import { Core } from "<sdk-package-name>";
-import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
-
-const client = new Core();
-
-async function run() {
-  const result = await fetchSomething(client, { id: "123" });
-  if (!result.ok) {
-    // You can throw the error or handle it. It's your choice now.
-    throw result.error;
-  }
-
-  console.log(result.value);
-}
-
-run();
-```
-
-Notably, `result.error` above will have an explicit type compared to a try-catch
-variation where the error in the catch block can only be of type `unknown` (or
-`any` depending on your TypeScript settings).

package/RUNTIMES.md

@@ -1,48 +0,0 @@
-# Supported JavaScript runtimes
-
-This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
-
-- [Web Fetch API][web-fetch]
-- [Web Streams API][web-streams] and in particular `ReadableStream`
-- [Async iterables][async-iter] using `Symbol.asyncIterator`
-
-[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
-[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
-[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
-
-Runtime environments that are explicitly supported are:
-
-- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
-- Node.js active and maintenance LTS releases
-  - Currently, this is v18 and v20
-- Bun v1 and above
-- Deno v1.39
-  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
-
-[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
-
-## Recommended TypeScript compiler options
-
-The following `tsconfig.json` options are recommended for projects using this
-SDK in order to get static type support for features like async iterables,
-streams and `fetch`-related APIs ([`for await...of`][for-await-of],
-[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
-so on):
-
-[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
-[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
-[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
-[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
-
-```jsonc
-{
-  "compilerOptions": {
-    "target": "es2020", // or higher
-    "lib": ["es2020", "dom", "dom.iterable"]
-  }
-}
-```
-
-While `target` can be set to older ECMAScript versions, it may result in extra,
-unnecessary compatibility code being generated if you are not targeting old
-runtimes.

package/_speakeasy/.github/action-inputs-config.json

@@ -1,53 +0,0 @@
-[
-  {
-    "name": "mode",
-    "validation_regex": "/^(direct|pr)$/.source",
-    "validation_message": "Must be `direct` or `pr`"
-  },
-  {
-    "name": "speakeasy_version",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "openapi_doc_location",
-    "validation_regex": "/^((https?):\\/\\/([\\w\\-]+\\.)+\\w+(\\/.*)?|[\\w.\\-\\/]+)$/i.source",
-    "validation_message": "Must be a valid server URL or file path containing letters, numbers, or .-_/ only"
-  },
-  {
-    "name": "openapi_doc_auth_header",
-    "validation_regex": "/^[A-Za-z\\-]+$/.source",
-    "validation_message": "Letters or - only"
-  },
-  {
-    "name": "create_release"
-  },
-  {
-    "name": "publish_python",
-    "language": "python"
-  },
-  {
-    "name": "publish_typescript",
-    "language": "typescript"
-  },
-  {
-    "name": "publish_java",
-    "language": "java"
-  },
-  {
-    "name": "publish_php",
-    "language": "php"
-  },
-  {
-    "name": "publish_ruby",
-    "language": "ruby"
-  },
-  {
-    "name": "publish_csharp",
-    "language": "csharp"
-  },
-  {
-    "name": "publish_terraform",
-    "language": "terraform"
-  }
-]

package/_speakeasy/.github/action-security-config.json

@@ -1,88 +0,0 @@
-[
-  {
-    "name": "pypi_token",
-    "secret_name": "PYPI_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "python"
-  },
-  {
-    "name": "npm_token",
-    "secret_name": "NPM_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "typescript"
-  },
-  {
-    "name": "packagist_username",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "php"
-  },
-  {
-    "name": "packagist_token",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "php"
-  },
-  {
-    "name": "openapi_doc_auth_token",
-    "secret_name": "SPEC_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "speakeasy_api_key",
-    "secret_name": "SPEAKEASY_API_KEY",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "ossrh_username",
-    "secret_name": "MAVEN_USERNAME",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "java"
-  },
-  {
-    "name": "ossrh_password",
-    "secret_name": "MAVEN_PASSWORD",
-    "language": "java"
-  },
-  {
-    "name": "java_gpg_secret_key",
-    "validation_regex": "/^[\\w.\\-\\t \\r\\n]+$/.source",
-    "validation_message": "Letters, numbers, tabs, spaces, newlines, or .-_ only",
-    "language": "java"
-  },
-  {
-    "name": "java_gpg_passphrase",
-    "language": "java"
-  },
-  {
-    "name": "terraform_gpg_secret_key",
-    "secret_name": "TERRAFORM_GPG_SECRET_KEY",
-    "validation_regex": "/^[\\w.\\-\\t \\r\\n]+$/.source",
-    "validation_message": "Letters, numbers, tabs, spaces, newlines, or .-_ only",
-    "language": "terraform"
-  },
-  {
-    "name": "terraform_gpg_passphrase",
-    "secret_name": "TERRAFORM_GPG_PASSPHRASE",
-    "language": "terraform"
-  },
-  {
-    "name": "rubygems_auth_token",
-    "secret_name": "RUBYGEMS_AUTH_TOKEN",
-    "language": "ruby"
-  },
-  {
-    "name": "nuget_api_key",
-    "secret_name": "NUGET_API_KEY",
-    "language": "csharp"
-  },
-  {
-    "name": "slack_webhook_url",
-    "secret_name": "SLACK_WEBHOOK_URL"
-  }
-]

package/dist/commonjs/core.d.ts

@@ -1,10 +0,0 @@
-import { ClientSDK } from "./lib/sdks.js";
-/**
- * A minimal client to use when calling standalone SDK functions. Typically, an
- * instance of this class would be instantiated once at the start of an
- * application and passed around through some dependency injection mechanism  to
- * parts of an application that need to make SDK calls.
- */
-export declare class EmailrCore extends ClientSDK {
-}
-//# sourceMappingURL=core.d.ts.map

package/dist/commonjs/core.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,SAAS;CAAG"}

package/dist/commonjs/core.js

@@ -1,17 +0,0 @@
-"use strict";
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmailrCore = void 0;
-const sdks_js_1 = require("./lib/sdks.js");
-/**
- * A minimal client to use when calling standalone SDK functions. Typically, an
- * instance of this class would be instantiated once at the start of an
- * application and passed around through some dependency injection mechanism  to
- * parts of an application that need to make SDK calls.
- */
-class EmailrCore extends sdks_js_1.ClientSDK {
-}
-exports.EmailrCore = EmailrCore;
-//# sourceMappingURL=core.js.map

package/dist/commonjs/core.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"core.js","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,MAAa,UAAW,SAAQ,mBAAS;CAAG;AAA5C,gCAA4C"}

package/dist/commonjs/funcs/apiKeysCreate.d.ts

@@ -1,18 +0,0 @@
-import { EmailrCore } from "../core.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { EmailrError } from "../models/errors/emailrerror.js";
-import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
-import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import * as models from "../models/index.js";
-import { APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-/**
- * Create API key
- *
- * @remarks
- * Create a new API key for programmatic access
- */
-export declare function apiKeysCreate(client: EmailrCore, request?: models.CreateApiKeyRequest | undefined, options?: RequestOptions): APIPromise<Result<models.ApiKey, errors.ErrorT | EmailrError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
-//# sourceMappingURL=apiKeysCreate.d.ts.map

package/dist/commonjs/funcs/apiKeysCreate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"apiKeysCreate.d.ts","sourceRoot":"","sources":["../../../src/funcs/apiKeysCreate.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAKxC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,MAAM,CAAC,mBAAmB,GAAG,SAAS,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,MAAM,EACX,MAAM,CAAC,MAAM,GACb,WAAW,GACX,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}