@readme/httpsnippet 4.0.2 → 4.0.5

package/dist/targets/node/request/fixtures/query.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/request/fixtures/short.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/request/fixtures/text-plain.d.ts

@@ -0,0 +1 @@
+export {};

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

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

package/dist/targets/node/unirest/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for Node.js using Unirest.
+ *
+ * @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 declare const unirest: Client;

package/dist/targets/node/unirest/fixtures/application-form-encoded.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/application-json.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/cookies.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/custom-method.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/full.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/headers.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/http-insecure.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/jsonObj-multiline.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/jsonObj-null-value.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/multipart-data.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/multipart-file.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/multipart-form-data-no-params.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/multipart-form-data.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/nested.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/postdata-malformed.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/postdata-malformed.js

@@ -0,0 +1,11 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'content-type': 'application/json'
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/query-encoded.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/query.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/short.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/text-plain.d.ts

@@ -0,0 +1 @@
+export {};

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;