@sebastienrousseau/crypto-api 0.0.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © Sebastien Rousseau 2022. All rights reserved.
+
+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 NON-INFRINGEMENT. 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

@@ -0,0 +1,258 @@
+<!-- SPDX-License-Identifier: Apache-2.0 OR MIT -->
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/sebastienrousseau/crypto-service/main/assets/crypto-api-logo.svg" alt="crypto-api logo" width="360" />
+</p>
+
+<h1 align="center">@sebastienrousseau/crypto-api</h1>
+
+<p align="center">
+  Shared TypeScript types and utilities for the Crypto Service Suite, defining the canonical API surface.
+</p>
+
+<p align="center">
+  <a href="https://github.com/sebastienrousseau/crypto-service/actions"><img src="https://img.shields.io/github/actions/workflow/status/sebastienrousseau/crypto-service/ci.yml?branch=main&style=for-the-badge&logo=github" alt="Build" /></a>
+  <a href="https://coveralls.io/github/sebastienrousseau/crypto-service?branch=main"><img src="https://img.shields.io/coveralls/github/sebastienrousseau/crypto-service?branch=main&style=for-the-badge" alt="Coverage" /></a>
+  <a href="https://www.npmjs.com/package/@sebastienrousseau/crypto-api"><img src="https://img.shields.io/npm/v/@sebastienrousseau/crypto-api.svg?style=for-the-badge&color=f14041&logo=npm" alt="Registry" /></a>
+  <a href="https://sebastienrousseau.github.io/crypto-service/"><img src="https://img.shields.io/badge/docs-TypeDoc-blue.svg?style=for-the-badge&labelColor=555555&logo=typescript" alt="Docs" /></a>
+  <a href="https://scorecard.dev/viewer/?uri=github.com/sebastienrousseau/crypto-service" title="ossf-scorecard"><img src="https://img.shields.io/badge/OpenSSF-Scorecard-blue?style=for-the-badge&logo=openssf" alt="OpenSSF Scorecard" /></a>
+  <a href="https://github.com/sebastienrousseau/crypto-service/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0%20OR%20MIT-blue.svg?style=for-the-badge" alt="License: Apache-2.0 OR MIT" /></a>
+  <a href="https://github.com/sebastienrousseau/crypto-service/blob/main/docs/POLICIES.md"><img src="https://img.shields.io/badge/Node.js-%3E%3D22-93450a.svg?style=for-the-badge&logo=node.js" alt="Node.js 22 or newer" /></a>
+</p>
+
+---
+
+## Contents
+
+**Getting started**
+
+- [Install](#install) — installation via pnpm, npm, or yarn
+- [Requirements](#requirements) — runtime floor and environment prerequisites
+- [Quick Start](#quick-start) — minimal working usage sample
+
+**The Crypto Service ecosystem**
+
+- [The Crypto Service ecosystem](#the-crypto-service-ecosystem) — full 14-package suite overview
+
+**Package reference**
+
+- [Reference & Usage](#overview) — features, configuration, and capabilities
+- [Examples](#examples) — runnable sample code
+
+**Operational**
+
+- [Development](#development) — build, lint, format, and test targets
+- [Security](#security) — vulnerability disclosure and cryptographic invariants
+- [Documentation](#documentation) — TypeDoc API docs and ecosystem guides
+- [Stability guarantees](#stability-guarantees) — SemVer axis and release policy
+- [License](#license)
+
+---
+
+## Install
+
+```bash
+pnpm add @sebastienrousseau/crypto-api
+# or
+npm install @sebastienrousseau/crypto-api
+# or
+yarn add @sebastienrousseau/crypto-api
+```
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## Requirements
+
+- **Node.js**: `^22.0.0` or `>=24.0.0` (active and maintenance LTS releases)
+- **Package Manager**: `pnpm >=9` (recommended) or `npm >=10`
+- **TypeScript**: `>=5.0` (when compiling with TypeScript)
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## Quick Start
+
+Import shared types and use them to build type-safe requests and
+responses across `crypto-server` and `crypto-sdk`.
+
+```ts
+import type {
+  AuthorizationToken,
+  AuthorizationInfo,
+  CollectionItem,
+  JsonDocument,
+  JsonRequest,
+  RequestHeader,
+  ResponseType,
+} from "@sebastienrousseau/crypto-api/dist/@types/types";
+
+// Type-safe request header
+const header: RequestHeader = {
+  key: "Content-Type",
+  value: "application/json",
+  description: "Request content type",
+};
+
+// Build a typed JSON request
+const request: JsonRequest = {
+  header: [header],
+  key: "encrypt",
+  value: "aes-256-gcm",
+  description: "Encrypt payload with AES-256-GCM",
+};
+```
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## The Crypto Service ecosystem
+
+Crypto Service provides a complete cryptography stack across 14 specialized packages:
+
+| Package                                                               | Role            | Description                                                                                                                            |
+| :-------------------------------------------------------------------- | :-------------- | :------------------------------------------------------------------------------------------------------------------------------------- |
+| **[`@sebastienrousseau/crypto-api`](../crypto-api)** _(this package)_ | **API Schemas** | **Shared TypeScript types and utilities for the Crypto Service Suite, defining the canonical API surface.**                            |
+| [`@sebastienrousseau/crypto-cli`](../crypto-cli)                      | Terminal CLI    | An interactive command-line interface for cryptographic operations, supporting both legacy OpenPGP and modern post-quantum algorithms. |
+| [`@sebastienrousseau/crypto-edge`](../crypto-edge)                    | Edge Runtime    | Edge-runtime cryptographic operations using the Web Crypto API, optimized for Cloudflare Workers, Vercel Edge, and Deno.               |
+| [`@sebastienrousseau/crypto-kms`](../crypto-kms)                      | Cloud KMS       | Unified Key Management Service interface for AWS KMS, GCP Cloud KMS, Azure Key Vault, and HashiCorp Vault.                             |
+| [`@sebastienrousseau/crypto-lib`](../crypto-lib)                      | Core Library    | A modern cryptographic library for TypeScript, with post-quantum support, zero unsafe dependencies, and 100% test coverage.            |
+| [`@sebastienrousseau/crypto-middleware`](../crypto-middleware)        | Middleware      | Framework-agnostic cryptographic middleware for Express, Fastify, and Koa applications.                                                |
+| [`@sebastienrousseau/crypto-prisma`](../crypto-prisma)                | ORM Adapter     | Transparent field-level encryption extension for Prisma Client, using XChaCha20-Poly1305.                                              |
+| [`@sebastienrousseau/crypto-react`](../crypto-react)                  | React Hooks     | React hooks and context provider for client-side cryptographic operations with zero boilerplate.                                       |
+| [`@sebastienrousseau/crypto-sdk`](../crypto-sdk)                      | Client SDK      | A zero-dependency, typed HTTP client for the Crypto Service REST API, with full post-quantum support.                                  |
+| [`@sebastienrousseau/crypto-server`](../crypto-server)                | HTTP API        | A hardened Fastify REST API for cryptographic operations, with rate limiting, OpenAPI schemas, and post-quantum endpoints.             |
+| [`@sebastienrousseau/crypto-testing`](../crypto-testing)              | Test Support    | Deterministic keys, fast mocks, and test fixtures for crypto-lib                                                                       |
+| [`@sebastienrousseau/crypto-typeorm`](../crypto-typeorm)              | ORM Adapter     | TypeORM column-level encryption with a single decorator, powered by crypto-lib.                                                        |
+| [`@sebastienrousseau/crypto-vue`](../crypto-vue)                      | Vue Composables | Vue 3 composables for client-side cryptography                                                                                         |
+| [`@sebastienrousseau/crypto-wasm`](../crypto-wasm)                    | Acceleration    | WebAssembly performance accelerator for crypto-lib                                                                                     |
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## Overview
+
+crypto-api provides the shared TypeScript type definitions and
+utility functions used across the Crypto Service Suite. It defines
+the canonical API surface -- request headers, response types,
+authorization tokens, and collection items -- that `crypto-server`,
+`crypto-sdk`, and other packages depend on. Utility functions convert
+Postman-style JSON collections into Markdown documentation.
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+## Features
+
+### Exported Types
+
+All types are exported from `src/@types/types.ts`.
+
+| Type                 | Description                                                                     |
+| :------------------- | :------------------------------------------------------------------------------ |
+| `AuthorizationToken` | A single authorization token with `key`, `type`, and `value` fields             |
+| `AuthorizationInfo`  | Full authorization payload including bearer tokens and metadata                 |
+| `CollectionItem`     | A Postman-style collection item -- either a folder with children or an endpoint |
+| `JsonDocument`       | Top-level document with `info` metadata and an array of `CollectionItem`s       |
+| `MethodType`         | A named method with optional `request` and `response` details                   |
+| `JsonRequest`        | An API request shape with headers, key/value pair, and description              |
+| `RequestHeader`      | A single request header with `key`, `value`, and `description`                  |
+| `ResponseType`       | A response entry with HTTP `code`, `status`, and `body`                         |
+
+### Utilities
+
+Utility functions are exported from `src/utils/index.ts`. They
+convert Postman-style JSON collections into Markdown documentation.
+
+| Function            | Description                                         |
+| :------------------ | :-------------------------------------------------- |
+| `createMarkdown`    | Converts a full JSON document to Markdown           |
+| `readAuthorization` | Renders authorization info as a Markdown table      |
+| `readRequest`       | Renders request headers as a Markdown table         |
+| `readQueryParams`   | Renders query parameters as a Markdown table        |
+| `readFormDataBody`  | Renders raw or form-data request bodies in Markdown |
+| `readResponse`      | Renders response codes and an example response body |
+| `readMethods`       | Renders a single API method with all its sections   |
+| `readItems`         | Recursively renders a collection tree to Markdown   |
+| `response`          | Writes generated Markdown to a file on disk         |
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+## Examples
+
+All examples are self-contained TypeScript files in the `examples/`
+directory. Run any example with:
+
+```bash
+npx ts-node examples/<name>.ts
+```
+
+| Category   | Example                                 | Purpose                                |
+| :--------- | :-------------------------------------- | :------------------------------------- |
+| Types      | [types.ts](examples/types.ts)           | Using API types for type-safe requests |
+| Utilities  | [utilities.ts](examples/utilities.ts)   | Using exported utility functions       |
+| Validation | [validation.ts](examples/validation.ts) | Validating API payloads against types  |
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## Development
+
+```bash
+pnpm --filter @sebastienrousseau/crypto-api run build
+pnpm --filter @sebastienrousseau/crypto-api run test
+pnpm --filter @sebastienrousseau/crypto-api run lint
+pnpm --filter @sebastienrousseau/crypto-api run format
+```
+
+All 18 packages in the Crypto Service workspace maintain a **100% coverage floor** across statements, branches, functions, and lines.
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## Security
+
+Report vulnerabilities privately via [GitHub Security Advisories](https://github.com/sebastienrousseau/crypto-service/security/advisories) or according to [`SECURITY.md`](../../SECURITY.md). Never report security issues publicly.
+
+Cryptographic operations use the `@noble/*` libraries, Node.js `crypto` and OpenPGP.js. `@noble/post-quantum` has not been independently audited and does not guarantee constant-time execution, and no module in this suite is FIPS 140-3 validated. Key zeroization is limited: JavaScript strings and garbage-collected buffers cannot be reliably wiped. See [`SECURITY.md`](../../SECURITY.md).
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## Documentation
+
+- [Full Suite Documentation](https://sebastienrousseau.github.io/crypto-service/)
+- [API Reference (TypeDoc)](https://sebastienrousseau.github.io/crypto-service/)
+- [Developer Guide](../../DEVELOPMENT.md)
+- [Security Policy](../../SECURITY.md)
+- [Architecture & Design](../../ARCHITECTURE.md)
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## Stability guarantees
+
+Versions advance strictly one step at a time on the `0.0.x` line (`v0.0.1` → `v0.0.2` → `v0.0.3` ... → `v0.0.999` → `v0.1.0`). Work for every release iteration begins on a dedicated `feat/v<version>` branch.
+
+All 18 packages in the workspace move in lockstep. Public API signatures, cipher output formats, and serialization schemas are strictly versioned. Breaking changes to serialized formats or algorithm defaults are considered major breaking changes. Minimum toolchain upgrades (e.g. Node.js LTS floor) are governed by [POLICIES.md](../../docs/POLICIES.md).
+
+<p align="right"><a href="#contents">Back to Top</a></p>
+
+---
+
+## License
+
+Dual-licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) or [MIT](https://opensource.org/licenses/MIT), at your option.
+
+Copyright (c) 2022-2026 Sebastien Rousseau and The Crypto Service Suite contributors.
+
+<p align="right"><a href="#contents">Back to Top</a></p>

package/dist/@types/types.d.ts

@@ -0,0 +1,46 @@
+export type AuthorizationToken = {
+    key: string;
+    type: string;
+    value: string;
+};
+export type AuthorizationInfo = {
+    bearer: AuthorizationToken[];
+    key: string;
+    type: string;
+    value: string;
+};
+export type CollectionItem = {
+    name: string;
+    item?: CollectionItem[];
+    request?: JsonRequest;
+    response?: ResponseType[];
+};
+export type JsonDocument = {
+    info: {
+        description: string;
+        name: string;
+    };
+    item: CollectionItem[];
+};
+export type MethodType = {
+    request?: JsonRequest;
+    name: string;
+    response?: ResponseType[];
+};
+export type JsonRequest = {
+    header: RequestHeader[];
+    key: string;
+    value: string;
+    description: string;
+};
+export type RequestHeader = {
+    key: string;
+    value: string;
+    description: string;
+};
+export type ResponseType = {
+    code: number;
+    status: string;
+    body: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/@types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/@types/types.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,kBAAkB,GAAG;IAE/B,GAAG,EAAE,MAAM,CAAC;IAEZ,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAKF,MAAM,MAAM,iBAAiB,GAAG;IAE9B,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAE7B,GAAG,EAAE,MAAM,CAAC;IAEZ,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAMF,MAAM,MAAM,cAAc,GAAG;IAE3B,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,CAAC,EAAE,cAAc,EAAE,CAAC;IAExB,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAEzB,IAAI,EAAE;QAEJ,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF,IAAI,EAAE,cAAc,EAAE,CAAC;CACxB,CAAC;AAKF,MAAM,MAAM,UAAU,GAAG;IAEvB,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B,CAAC;AAKF,MAAM,MAAM,WAAW,GAAG;IAExB,MAAM,EAAE,aAAa,EAAE,CAAC;IAExB,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAKF,MAAM,MAAM,aAAa,GAAG;IAE1B,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAEzB,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/@types/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export declare function init(): Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAiCA,wBAAsB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAqE1C"}

package/dist/index.js

@@ -0,0 +1,80 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = init;
+const minimist = require("minimist");
+const fs = __importStar(require("fs/promises"));
+const utils_1 = require("./utils");
+async function init() {
+    try {
+        const args = minimist(process.argv.slice(2));
+        const [filePath, outputFileName] = args["_"];
+        if (!filePath) {
+            console.log("Path of JSON file is required.");
+            return;
+        }
+        console.log(`Reading file ${filePath}`);
+        try {
+            await fs.access(filePath);
+        }
+        catch {
+            console.log("Path is not valid or the file does not exist.");
+            return;
+        }
+        console.log("Generating markdown file ...");
+        const rawData = await fs.readFile(filePath);
+        const json = JSON.parse(rawData.toString());
+        let markdown = (0, utils_1.createMarkdown)(json);
+        markdown +=
+            "[divider]: https://raw.githubusercontent.com/sebastienrousseau/crypto-service/main/assets/divider.svg\n";
+        if (outputFileName) {
+            const fileName = outputFileName.split(".")[0];
+            (0, utils_1.response)(markdown, fileName);
+        }
+        else {
+            console.log("Output file name is required.");
+        }
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            console.error("An error occurred:", error.message);
+        }
+        else {
+            console.error("An unknown error occurred:", error);
+        }
+    }
+}
+init();
+//# sourceMappingURL=index.js.map

package/dist/utils/index.d.ts

@@ -0,0 +1,52 @@
+import { AuthorizationInfo, JsonDocument, JsonRequest, ResponseType } from "../@types/types";
+export interface UrlWithQuery {
+    query?: Array<{
+        key: string;
+        value: string;
+    }>;
+}
+export interface BodyFormField {
+    key: string;
+    type: string;
+    src?: string;
+    value?: string;
+}
+export interface BodyShape {
+    mode?: string;
+    raw?: string;
+    formdata?: BodyFormField[];
+}
+export interface MethodLike {
+    name: string;
+    request?: JsonRequest & {
+        method?: string;
+        description?: string;
+        url?: UrlWithQuery | string;
+        body?: BodyShape;
+        auth?: AuthorizationInfo;
+    };
+    response?: ResponseType[];
+}
+export interface ItemShape {
+    name: string;
+    item?: ItemShape[];
+    request?: MethodLike["request"];
+    response?: MethodLike["response"];
+}
+export declare const cell: (value: unknown) => string;
+export declare const createMarkdown: (data: JsonDocument) => string;
+export declare const readAuthorization: (data: AuthorizationInfo | undefined) => string;
+export declare const readRequest: (data: JsonRequest | undefined) => string;
+export declare const readQueryParams: (url: UrlWithQuery | string | null | undefined) => string;
+export declare const readFormDataBody: (body: BodyShape | null | undefined) => string;
+export declare const readResponse: (responses: ResponseType[] | undefined) => string;
+export declare const readMethods: (method: MethodLike) => string;
+export declare const readItems: (items: ItemShape[], folderDeep?: number) => string;
+export declare const docsDir: () => string;
+export declare const response: (content: string, fileName: string) => Promise<void>;
+declare const utils: {
+    createMarkdown: typeof createMarkdown;
+    response: typeof response;
+};
+export default utils;
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,YAAY,EACb,MAAM,iBAAiB,CAAC;AAYzB,MAAM,WAAW,YAAY;IAE3B,KAAK,CAAC,EAAE,KAAK,CAAC;QAEZ,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE,MAAM,CAAC;KACf,CAAC,CAAC;CACJ;AAUD,MAAM,WAAW,aAAa;IAE5B,GAAG,EAAE,MAAM,CAAC;IAEZ,IAAI,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAUD,MAAM,WAAW,SAAS;IAExB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B;AAUD,MAAM,WAAW,UAAU;IAEzB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,CAAC,EAAE,WAAW,GAAG;QAEtB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,GAAG,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;QAE5B,IAAI,CAAC,EAAE,SAAS,CAAC;QAEjB,IAAI,CAAC,EAAE,iBAAiB,CAAC;KAC1B,CAAC;IAEF,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B;AAUD,MAAM,WAAW,SAAS;IAExB,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IAEnB,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;IAEhC,QAAQ,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;CACnC;AAOD,eAAO,MAAM,IAAI,GAAI,OAAO,OAAO,KAAG,MAIZ,CAAC;AAK3B,eAAO,MAAM,cAAc,GAAI,MAAM,YAAY,KAAG,MAUnD,CAAC;AAKF,eAAO,MAAM,iBAAiB,GAC5B,MAAM,iBAAiB,GAAG,SAAS,KAClC,MAYF,CAAC;AAKF,eAAO,MAAM,WAAW,GAAI,MAAM,WAAW,GAAG,SAAS,KAAG,MAc3D,CAAC;AAKF,eAAO,MAAM,eAAe,GAC1B,KAAK,YAAY,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,KAC5C,MAYF,CAAC;AAeF,eAAO,MAAM,gBAAgB,GAC3B,MAAM,SAAS,GAAG,IAAI,GAAG,SAAS,KACjC,MAsBF,CAAC;AAKF,eAAO,MAAM,YAAY,GAAI,WAAW,YAAY,EAAE,GAAG,SAAS,KAAG,MAgBpE,CAAC;AAKF,eAAO,MAAM,WAAW,GAAI,QAAQ,UAAU,KAAG,MAkBhD,CAAC;AAKF,eAAO,MAAM,SAAS,GAAI,OAAO,SAAS,EAAE,EAAE,mBAAc,KAAG,MAY9D,CAAC;AAMF,eAAO,MAAM,OAAO,QAAO,MACiD,CAAC;AAK7E,eAAO,MAAM,QAAQ,GACnB,SAAS,MAAM,EACf,UAAU,MAAM,KACf,OAAO,CAAC,IAAI,CAMd,CAAC;AAaF,QAAA,MAAM,KAAK,EAAE;IAEX,cAAc,EAAE,OAAO,cAAc,CAAC;IAEtC,QAAQ,EAAE,OAAO,QAAQ,CAAC;CACI,CAAC;AAGjC,eAAe,KAAK,CAAC"}

package/dist/utils/index.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.response = exports.docsDir = exports.readItems = exports.readMethods = exports.readResponse = exports.readFormDataBody = exports.readQueryParams = exports.readRequest = exports.readAuthorization = exports.createMarkdown = exports.cell = void 0;
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const cell = (value) => String(value ?? "")
+    .replace(/\r?\n/g, " ")
+    .replace(/\\/g, "\\\\")
+    .replace(/\|/g, "\\|");
+exports.cell = cell;
+const createMarkdown = (data) => {
+    if (!data || !data.info)
+        return "";
+    const parts = [];
+    parts.push(`# ${data.info.name || ""}\n\n`);
+    if (data.info.description !== undefined) {
+        parts.push(`${data.info.description || ""}\n`);
+    }
+    parts.push((0, exports.readItems)((data.item || [])));
+    parts.push("\n");
+    return parts.join("");
+};
+exports.createMarkdown = createMarkdown;
+const readAuthorization = (data) => {
+    if (!data || !data.bearer)
+        return "";
+    const parts = [];
+    parts.push(`## 🔑 Authentication ${data.type}\n\n`);
+    parts.push("|Param|value|Type|\n");
+    parts.push("|---|---|---|\n");
+    for (let i = 0, len = data.bearer.length; i < len; i++) {
+        const auth = data.bearer[i];
+        parts.push(`|${(0, exports.cell)(auth.key)}|${(0, exports.cell)(auth.value)}|${(0, exports.cell)(auth.type)}|\n`);
+    }
+    parts.push("\n");
+    return parts.join("");
+};
+exports.readAuthorization = readAuthorization;
+const readRequest = (data) => {
+    if (!data || !data.header)
+        return "";
+    const parts = [];
+    parts.push("### Request Headers\n\n");
+    parts.push("|Parameter|Value|Description|\n");
+    parts.push("|---|---|---|\n");
+    for (let i = 0, len = data.header.length; i < len; i++) {
+        const header = data.header[i];
+        parts.push(`|${(0, exports.cell)(header.key)}|${(0, exports.cell)(header.value)}|${(0, exports.cell)(header.description)}|\n`);
+    }
+    parts.push("\n");
+    return parts.join("");
+};
+exports.readRequest = readRequest;
+const readQueryParams = (url) => {
+    if (!url || typeof url === "string" || !url.query)
+        return "";
+    const parts = [];
+    parts.push("### Query Params\n\n");
+    parts.push("|Param|value|\n");
+    parts.push("|---|---|\n");
+    for (let i = 0, len = url.query.length; i < len; i++) {
+        const param = url.query[i];
+        if (param)
+            parts.push(`|${(0, exports.cell)(param.key)}|${(0, exports.cell)(param.value)}|\n`);
+    }
+    parts.push("\n");
+    return parts.join("");
+};
+exports.readQueryParams = readQueryParams;
+function formatFieldValue(form) {
+    if (form.type === "file") {
+        return form.src ?? "";
+    }
+    return form.value !== undefined ? form.value.replace(/\\n/g, "") : "";
+}
+const readFormDataBody = (body) => {
+    if (!body)
+        return "";
+    const parts = [];
+    if (body.mode === "raw") {
+        parts.push(`### Body (**${body.mode}**)\n\n`);
+        parts.push("```json\n");
+        parts.push(`${body.raw ?? ""}\n`);
+        parts.push("```\n\n");
+    }
+    if (body.mode === "formdata" && body.formdata) {
+        parts.push(`### Body ${body.mode}\n\n`);
+        parts.push("|Param|value|Type|\n");
+        parts.push("|---|---|---|\n");
+        for (let i = 0, len = body.formdata.length; i < len; i++) {
+            const form = body.formdata[i];
+            parts.push(`|${(0, exports.cell)(form.key)}|${(0, exports.cell)(formatFieldValue(form))}|${(0, exports.cell)(form.type)}|\n`);
+        }
+        parts.push("\n");
+    }
+    return parts.join("");
+};
+exports.readFormDataBody = readFormDataBody;
+const readResponse = (responses) => {
+    if (!responses || responses.length === 0)
+        return "";
+    const parts = [];
+    const first = responses[0];
+    parts.push("### Response\n\n");
+    parts.push("|Code|Status|\n");
+    parts.push("|---|---|\n");
+    for (let i = 0, len = responses.length; i < len; i++) {
+        const resp = responses[i];
+        if (resp)
+            parts.push(`|${(0, exports.cell)(resp.code)}|${(0, exports.cell)(resp.status)}|\n`);
+    }
+    parts.push("\n#### Example response\n\n");
+    parts.push("```json\n");
+    parts.push(`${first.body}\n`);
+    parts.push("```\n\n");
+    return parts.join("");
+};
+exports.readResponse = readResponse;
+const readMethods = (method) => {
+    const parts = ["\n"];
+    if (method.request?.description !== undefined) {
+        parts.push(`#${method.request.description || ""}\n\n`);
+    }
+    parts.push(`### ${method.request?.method ?? ""} ${method.name}\n\n`);
+    parts.push(">```\n");
+    const urlString = typeof method.request?.url === "string" ? method.request.url : "";
+    parts.push(`>${urlString}\n`);
+    parts.push(">```\n\n");
+    parts.push((0, exports.readRequest)(method.request));
+    parts.push((0, exports.readFormDataBody)(method.request?.body));
+    parts.push((0, exports.readQueryParams)(method.request?.url));
+    parts.push((0, exports.readAuthorization)(method.request?.auth));
+    parts.push((0, exports.readResponse)(method.response));
+    parts.push("![divider][divider]\n");
+    return parts.join("");
+};
+exports.readMethods = readMethods;
+const readItems = (items, folderDeep = 1) => {
+    const parts = [];
+    for (let i = 0, len = items.length; i < len; i++) {
+        const item = items[i];
+        if (item.item) {
+            parts.push(`${"#".repeat(folderDeep)} 📁 Collection: ${item.name} \n`);
+            parts.push((0, exports.readItems)(item.item, folderDeep + 1));
+        }
+        else {
+            parts.push((0, exports.readMethods)(item));
+        }
+    }
+    return parts.join("");
+};
+exports.readItems = readItems;
+const docsDir = () => process.env["CRYPTO_API_DOCS_DIR"] ?? (0, path_1.resolve)(__dirname, "../../src/docs");
+exports.docsDir = docsDir;
+const response = async (content, fileName) => {
+    const dir = (0, exports.docsDir)();
+    await (0, promises_1.mkdir)(dir, { recursive: true });
+    const safeName = (0, path_1.basename)(fileName);
+    await (0, promises_1.writeFile)((0, path_1.join)(dir, `${safeName}.md`), content, "utf8");
+};
+exports.response = response;
+const utils = { createMarkdown: exports.createMarkdown, response: exports.response };
+exports.default = utils;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,116 @@
+{
+  "author": "Sebastien Rousseau <sebastienrousseau@users.noreply.github.com>",
+  "autoupdate": {
+    "fileMap": [
+      {
+        "basePath": "dist",
+        "files": [
+          "**/*"
+        ]
+      }
+    ],
+    "source": "git",
+    "target": "git://github.com/sebastienrousseau/crypto-service.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sebastienrousseau/crypto-service/issues"
+  },
+  "description": "The Crypto Service Suite APIs are typical REST APIs that use HTTPS requests and responses for common cryptographic operations.",
+  "dependencies": {
+    "minimist": "^1.2.8"
+  },
+  "devDependencies": {
+    "@sebastienrousseau/c8-config": "^0.0.3",
+    "@sebastienrousseau/eslint-config": "^0.0.2",
+    "@sebastienrousseau/jsdoc-config": "^0.0.5",
+    "@sebastienrousseau/markdownlint-config": "^0.0.1",
+    "@sebastienrousseau/mocha-config": "^0.0.5",
+    "@sebastienrousseau/prettier-config": "^0.0.4",
+    "@sebastienrousseau/remark-config": "^0.0.3",
+    "@types/chai": "^4.3.7",
+    "@types/chai-as-promised": "^8.0.2",
+    "@types/mocha": "^10.0.2",
+    "@types/node": "^26.4.1",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "c8": "^12.0.0",
+    "chai": "^4.5.0",
+    "chai-as-promised": "^7.1.2",
+    "eslint": "^8.57.1",
+    "eslint-import-resolver-typescript": "^3.10.1",
+    "eslint-plugin-import": "^2.28.1",
+    "filesizes": "^0.1.2",
+    "mocha": "^10.8.2",
+    "prettier": "^3.9.8",
+    "remark-cli": "^12.0.0",
+    "remark-footnotes": "^5.0.0",
+    "remark-preset-lint-consistent": "^6.0.1",
+    "remark-preset-lint-markdown-style-guide": "^5.1.3",
+    "remark-preset-lint-recommended": "^7.0.1",
+    "rimraf": "^6.1.3",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-missing-exports": "^4.1.4",
+    "typescript": "~5.9.3"
+  },
+  "directories": {
+    "src": "./src",
+    "test": "__tests__"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map"
+  ],
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/sebastienrousseau"
+    },
+    {
+      "type": "paypal",
+      "url": "https://paypal.me/wwdseb"
+    }
+  ],
+  "homepage": "https://crypto-api.io",
+  "keywords": [
+    "crypto-api"
+  ],
+  "license": "MIT OR Apache-2.0",
+  "license_URI": "http://www.opensource.org/licenses/mit-license.php",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "name": "@sebastienrousseau/crypto-api",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "directory": "packages/crypto-api",
+    "type": "git",
+    "url": "git@github.com:sebastienrousseau/crypto-service.git"
+  },
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "version": "0.0.7",
+  "scripts": {
+    "build": "tsc --build tsconfig.json",
+    "clean": "rimraf ./coverage ./dist ./docs",
+    "format": "prettier --write src/**/*.ts",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "lint": "eslint --ext .ts src __tests__",
+    "lint:fix": "eslint --cache --fix --ext .ts src __tests__",
+    "start": "node dist/index.js",
+    "test": "c8 --check-coverage --lines 100 --branches 100 --functions 100 --reporter=lcov --reporter=text mocha --config=.mocharc.cjs",
+    "docs": "typedoc"
+  }
+}