@readme/httpsnippet 4.0.2 → 4.0.3

package/dist/targets/objc/helpers.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Create a string corresponding to a valid declaration and initialization of an Objective-C object literal.
+ *
+ * @param nsClass Class of the litteral
+ * @param name Desired name of the instance
+ * @param parameters Key-value object of parameters to translate to an Objective-C object litearal
+ * @param indent If true, will declare the litteral by indenting each new key/value pair.
+ * @return A valid Objective-C declaration and initialization of an Objective-C object litteral.
+ *
+ * @example
+ *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'}, true)
+ *   // returns:
+ *   NSDictionary *params = @{ @"a": @"b",
+ *                             @"c": @"d" };
+ *
+ *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'})
+ *   // returns:
+ *   NSDictionary *params = @{ @"a": @"b", @"c": @"d" };
+ */
+export declare const nsDeclaration: (nsClass: string, name: string, parameters: Record<string, any>, indent?: boolean) => string;
+/**
+ * Create a valid Objective-C string of a literal value according to its type.
+ *
+ * @param value Any JavaScript literal
+ */
+export declare const literalRepresentation: (value: any, indentation?: number) => string;

package/dist/targets/objc/nsurlsession/client.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description
+ * HTTP code snippet generator for Objective-C using NSURLSession.
+ *
+ * @author
+ * @thibaultCha
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface NsurlsessionOptions {
+    pretty?: boolean;
+    timeout?: number;
+}
+export declare const nsurlsession: Client<NsurlsessionOptions>;

package/dist/targets/objc/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const objc: Target;

package/dist/targets/ocaml/cohttp/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for OCaml using CoHTTP.
+ *
+ * @author
+ * @SGrondin
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const cohttp: Client;

package/dist/targets/ocaml/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const ocaml: Target;

package/dist/targets/php/curl/client.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using curl-ext.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface CurlOptions {
+    closingTag?: boolean;
+    maxRedirects?: number;
+    nameErrors?: boolean;
+    noTags?: boolean;
+    shortTags?: boolean;
+    timeout?: number;
+}
+export declare const curl: Client<CurlOptions>;

package/dist/targets/php/guzzle/client.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using Guzzle.
+ *
+ * @author @RobertoArruda
+ * @author @erunion
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface GuzzleOptions {
+    closingTag?: boolean;
+    indent?: string;
+    noTags?: boolean;
+    shortTags?: boolean;
+}
+export declare const guzzle: Client<GuzzleOptions>;

package/dist/targets/php/helpers.d.ts

@@ -0,0 +1,2 @@
+export declare const convertType: (obj: any[] | any, indent?: string, lastIndent?: string) => any;
+export declare const supportedMethods: string[];

package/dist/targets/php/http1/client.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using curl-ext.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface Http1Options {
+    closingTag?: boolean;
+    noTags?: boolean;
+    shortTags?: boolean;
+}
+export declare const http1: Client<Http1Options>;

package/dist/targets/php/http2/client.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using curl-ext.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface Http2Options {
+    closingTag?: boolean;
+    noTags?: boolean;
+    shortTags?: boolean;
+}
+export declare const http2: Client<Http2Options>;

package/dist/targets/php/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const php: Target;

package/dist/targets/powershell/common.d.ts

@@ -0,0 +1,3 @@
+import type { Converter } from '../targets';
+export declare type PowershellCommand = 'Invoke-RestMethod' | 'Invoke-WebRequest';
+export declare const generatePowershellConvert: (command: PowershellCommand) => Converter<any>;

package/dist/targets/powershell/restmethod/client.d.ts

@@ -0,0 +1,2 @@
+import type { Client } from '../../targets';
+export declare const restmethod: Client;

package/dist/targets/powershell/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const powershell: Target;

package/dist/targets/powershell/webrequest/client.d.ts

@@ -0,0 +1,2 @@
+import type { Client } from '../../targets';
+export declare const webrequest: Client;

package/dist/targets/python/helpers.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Create a valid Python string of a literal value according to its type.
+ *
+ * @param {*} value Any JavaScript literal
+ * @param {Object} opts Target options
+ * @return {string}
+ */
+export declare const literalRepresentation: (value: any, opts: Record<string, any>, indentLevel?: number) => any;

package/dist/targets/python/requests/client.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @description
+ * HTTP code snippet generator for Python using Requests
+ *
+ * @author
+ * @montanaflynn
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface RequestsOptions {
+    pretty?: true;
+}
+export declare const requests: Client<RequestsOptions>;

package/dist/targets/python/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const python: Target;

package/dist/targets/r/httr/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for R using httr
+ *
+ * @author
+ * @gabrielakoreeda
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const httr: Client;

package/dist/targets/r/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const r: Target;

package/dist/targets/ruby/native/client.d.ts

@@ -0,0 +1,2 @@
+import type { Client } from '../../targets';
+export declare const native: Client;

package/dist/targets/ruby/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const ruby: Target;

package/dist/targets/shell/curl/client.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @description
+ *
+ * HTTP code snippet generator for the Shell using cURL.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface CurlOptions {
+    short?: boolean;
+    binary?: boolean;
+    globOff?: boolean;
+    indent?: string | false;
+    escapeBrackets?: boolean;
+}
+export declare const curl: Client<CurlOptions>;

package/dist/targets/shell/httpie/client.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @description
+ * HTTP code snippet generator for the Shell using HTTPie.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface HttpieOptions {
+    body?: boolean;
+    cert?: boolean;
+    headers?: boolean;
+    pretty?: boolean;
+    print?: boolean;
+    queryParams?: boolean;
+    short?: boolean;
+    style?: boolean;
+    timeout?: boolean;
+    verbose?: boolean;
+    verify?: boolean;
+}
+export declare const httpie: Client<HttpieOptions>;

package/dist/targets/shell/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const shell: Target;

package/dist/targets/shell/wget/client.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @description
+ * HTTP code snippet generator for the Shell using Wget.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface WgetOptions {
+    indent?: string | false;
+    short?: boolean;
+    verbose?: boolean;
+}
+export declare const wget: Client<WgetOptions>;

package/dist/targets/swift/helpers.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Create a string corresponding to a valid declaration and initialization of a Swift array or dictionary literal
+ *
+ * @param name Desired name of the instance
+ * @param parameters Key-value object of parameters to translate to a Swift object litearal
+ * @param opts Target options
+ * @return {string}
+ */
+export declare const literalDeclaration: <T, U>(name: string, parameters: T, opts: U) => string;
+/**
+ * Create a valid Swift string of a literal value according to its type.
+ *
+ * @param value Any JavaScript literal
+ * @param opts Target options
+ */
+export declare const literalRepresentation: <T, U>(value: T, opts: U, indentLevel?: number) => number | string;

package/dist/targets/swift/nsurlsession/client.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description
+ * HTTP code snippet generator for Swift using NSURLSession.
+ *
+ * @author
+ * @thibaultCha
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface NsurlsessionOptions {
+    pretty?: boolean;
+    timeout?: number | string;
+}
+export declare const nsurlsession: Client<NsurlsessionOptions>;

package/dist/targets/swift/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const swift: Target;

package/dist/targets/targets.d.ts

@@ -0,0 +1,52 @@
+import type { Merge } from 'type-fest';
+import type { CodeBuilderOptions } from '../helpers/code-builder';
+import type { Request } from '..';
+export declare type TargetId = keyof typeof targets;
+export declare type ClientId = string;
+export interface ClientInfo {
+    key: ClientId;
+    title: string;
+    link: string;
+    description: string;
+}
+export declare type Converter<T extends Record<string, any>> = (request: Request, options?: Merge<CodeBuilderOptions, T>) => string;
+export interface Client<T extends Record<string, any> = Record<string, any>> {
+    info: ClientInfo;
+    convert: Converter<T>;
+}
+export declare type Extension = `.${string}` | null;
+export interface TargetInfo {
+    key: TargetId;
+    title: string;
+    extname: Extension;
+    default: string;
+    cli?: string;
+}
+export interface Target {
+    info: TargetInfo;
+    clientsById: Record<ClientId, Client>;
+}
+export declare const targets: {
+    c: Target;
+    clojure: Target;
+    csharp: Target;
+    go: Target;
+    http: Target;
+    java: Target;
+    javascript: Target;
+    kotlin: Target;
+    node: Target;
+    objc: Target;
+    ocaml: Target;
+    php: Target;
+    powershell: Target;
+    python: Target;
+    r: Target;
+    ruby: Target;
+    shell: Target;
+    swift: Target;
+};
+export declare const isTarget: (target: Target) => target is Target;
+export declare const addTarget: (target: Target) => void;
+export declare const isClient: (client: Client) => client is Client<Record<string, any>>;
+export declare const addTargetClient: (targetId: TargetId, client: Client) => void;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.0.2",
+  "version": "4.0.3",
   "name": "@readme/httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",
@@ -48,7 +48,7 @@
   },
   "scripts": {
     "build": "tsc --build tsconfig.build.json",
-    "clean": "tsc --build tsconfig.build.json --clean",
+    "clean": "rm -rf dist/",
     "lint": "eslint .",
     "prebuild": "npm run clean",
     "prepack": "npm run build",

package/dist/package.json

@@ -1,86 +0,0 @@
-{
-    "version": "4.0.2",
-    "name": "@readme/httpsnippet",
-    "description": "HTTP Request snippet generator for *most* languages",
-    "homepage": "https://github.com/readmeio/httpsnippet",
-    "license": "MIT",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "keywords": [
-        "api",
-        "clojure",
-        "csharp",
-        "curl",
-        "go",
-        "har",
-        "http",
-        "httpie",
-        "httr",
-        "java",
-        "javascript",
-        "jquery",
-        "kotlin",
-        "objc",
-        "objective-c",
-        "ocaml",
-        "php",
-        "python",
-        "request",
-        "requests",
-        "ruby",
-        "shell",
-        "snippet",
-        "swift",
-        "swift",
-        "unirest",
-        "xhr",
-        "xmlhttprequest"
-    ],
-    "engines": {
-        "node": ">=14"
-    },
-    "files": [
-        "dist"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/readmeio/httpsnippet.git"
-    },
-    "scripts": {
-        "build": "tsc --build tsconfig.build.json",
-        "clean": "tsc --build tsconfig.build.json --clean",
-        "lint": "eslint .",
-        "prebuild": "npm run clean",
-        "prepack": "npm run build",
-        "pretest": "npm run lint",
-        "prettier": "prettier --list-different --write \"./**/**.js\"",
-        "test": "jest --coverage"
-    },
-    "devDependencies": {
-        "@readme/eslint-config": "^8.8.3",
-        "@types/eslint": "^8.4.1",
-        "@types/event-stream": "^4.0.0",
-        "@types/har-format": "^1.2.8",
-        "@types/jest": "^27.4.1",
-        "@types/node": "^16.11.26",
-        "@types/qs": "^6.9.7",
-        "@types/stringify-object": "^4.0.1",
-        "eslint": "^8.19.0",
-        "glob": "^8.0.1",
-        "jest": "^28.0.3",
-        "prettier": "^2.7.1",
-        "require-directory": "^2.1.1",
-        "ts-jest": "^28.0.5",
-        "type-fest": "^2.12.2",
-        "typescript": "^4.6.3"
-    },
-    "dependencies": {
-        "ajv": "^6.12.6",
-        "event-stream": "4.0.1",
-        "form-data": "^4.0.0",
-        "har-schema": "^2.0.0",
-        "qs": "^6.10.1",
-        "stringify-object": "^3.3.0"
-    },
-    "prettier": "@readme/eslint-config/prettier"
-}

package/dist/src/fixtures/customTarget.js

@@ -1,15 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.customTarget = void 0;
-var client_1 = require("../targets/node/request/client");
-exports.customTarget = {
-    info: {
-        key: 'js-variant',
-        title: 'JavaScript Variant',
-        extname: '.js',
-        "default": 'request'
-    },
-    clientsById: {
-        request: client_1.request
-    }
-};

package/dist/src/fixtures/mimetypes.js

@@ -1,77 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.mimetypes = void 0;
-exports.mimetypes = {
-    'multipart/mixed': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'multipart/mixed',
-            text: ''
-        }
-    },
-    'multipart/related': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'multipart/related',
-            text: ''
-        }
-    },
-    'multipart/form-data': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'multipart/form-data',
-            text: ''
-        }
-    },
-    'multipart/alternative': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'multipart/alternative',
-            text: ''
-        }
-    },
-    'application/x-www-form-urlencoded': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'application/x-www-form-urlencoded',
-            text: ''
-        }
-    },
-    'text/json': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'text/json',
-            text: ''
-        }
-    },
-    'text/x-json': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'text/x-json',
-            text: ''
-        }
-    },
-    'application/x-json': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'application/x-json',
-            text: ''
-        }
-    },
-    'invalid-json': {
-        method: 'POST',
-        url: 'https://httpbin.org/anything',
-        postData: {
-            mimeType: 'application/json',
-            text: 'foo/bar'
-        }
-    }
-};