@scalar/api-client 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,151 @@
+export type BasicAuth = {
+    userName: string;
+    password: string;
+    active: boolean;
+};
+export type OAuthTwo = {
+    generatedToken: string;
+    discoveryURL: string;
+    authURL: string;
+    accessTokenURL: string;
+    clientID: string;
+    clientSecret: string;
+    scope: string;
+    active: boolean;
+};
+export type Bearer = {
+    token: string;
+    active: boolean;
+};
+export type Digest = {
+    userName: string;
+    password: string;
+    active: boolean;
+};
+export type AuthType = 'basic' | 'oauthTwo' | 'bearer' | 'digest' | 'none';
+export type AuthState = {
+    type: AuthType;
+    basic: BasicAuth;
+    oauthTwo: OAuthTwo;
+    bearer: Bearer;
+    digest: Digest;
+};
+export type BaseParameter = {
+    name: string;
+    value: string | number;
+    customClass?: string;
+};
+export type Header = BaseParameter;
+export type Query = BaseParameter;
+export type FormDataItem = BaseParameter;
+/** Complete request state for a client request */
+export type ClientRequestConfig = {
+    id: string;
+    name: string;
+    url: string;
+    /** HTTP Request Method */
+    type: string;
+    /** Request path */
+    path: string;
+    /** Path parameters */
+    parameters: BaseParameter[];
+    /** Query parameters */
+    query: Query[];
+    /** Request headers */
+    headers: Header[];
+    /** Content type matched body */
+    body: string;
+    /** Optional form data body */
+    formData?: FormDataItem[];
+};
+/** Formatted request for the proxy server */
+export type ProxyPayload = {
+    method: string;
+    url: string;
+    body: string;
+    headers: Header[];
+    auth: Record<string, string>;
+    grpc: boolean;
+};
+/** Client response from the proxy */
+export type ClientResponse = {
+    cookies: Record<string, string>;
+    headers: Record<string, string>;
+    statusCode: number;
+    statusText: string;
+    data: string;
+    duration: number;
+};
+export type RequestResult = {
+    request: ClientRequestConfig;
+    response: ClientResponse;
+    responseId: string;
+    sentTime: number;
+};
+export type Schema = {
+    format: string;
+    type: string;
+};
+export type Parameters = {
+    description?: string;
+    in?: string;
+    name: string;
+    required?: boolean;
+    schema?: Schema;
+};
+export type Security = {
+    api_key?: any[];
+    petstore_auth?: string[];
+};
+export type ContentProperties = {
+    [key: string]: {
+        type: string;
+        format: string;
+        example: string;
+        required: string[];
+        description?: string;
+        properties?: ContentProperties;
+    };
+};
+export type ContentSchema = {
+    schema: {
+        type: string;
+        required: string[];
+        properties: ContentProperties;
+    };
+};
+export type ContentType = 'application/json' | 'application/xml' | 'text/plain' | 'text/html' | 'application/x-www-form-urlencoded' | 'multipart/form-data';
+export type Content = {
+    [key in ContentType]: ContentSchema;
+};
+export type RequestBody = {
+    description: string;
+    content: Content;
+    required: boolean;
+};
+export type Response = {
+    description: string;
+    content: any;
+};
+export type Information = {
+    description: string;
+    operationId: string;
+    parameters: Parameters[];
+    responses: Record<string, Response>;
+    security: Security[];
+    requestBody: RequestBody;
+    summary: string;
+    tags: string[];
+};
+export type Operation = {
+    httpVerb: string;
+    path: string;
+    operationId: string;
+    name: string;
+    description: string;
+    information: Information;
+};
+export type Server = {
+    url: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAA;AAE1E,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,EAAE,SAAS,CAAA;IAChB,QAAQ,EAAE,QAAQ,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,aAAa,CAAA;AAElC,MAAM,MAAM,KAAK,GAAG,aAAa,CAAA;AAEjC,MAAM,MAAM,YAAY,GAAG,aAAa,CAAA;AAExC,kDAAkD;AAClD,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,sBAAsB;IACtB,UAAU,EAAE,aAAa,EAAE,CAAA;IAC3B,uBAAuB;IACvB,KAAK,EAAE,KAAK,EAAE,CAAA;IACd,sBAAsB;IACtB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B,CAAA;AAED,6CAA6C;AAC7C,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5B,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,mBAAmB,CAAA;IAC5B,QAAQ,EAAE,cAAc,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,CAAC,EAAE,GAAG,EAAE,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,UAAU,EAAE,iBAAiB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,YAAY,GACZ,WAAW,GACX,mCAAmC,GACnC,qBAAqB,CAAA;AAEzB,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,GAAG,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,UAAU,EAAE,CAAA;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACnC,QAAQ,EAAE,QAAQ,EAAE,CAAA;IACpB,WAAW,EAAE,WAAW,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,WAAW,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA"}

package/dist/variables.css

@@ -0,0 +1,53 @@
+.scalar-api-client,
+#headlessui-portal-root {
+  /** Font sizes */
+  --scalar-api-client-text-xs: 12px;
+  --scalar-api-client-text-sm: 14px;
+  --scalar-api-client-text-base: 16px;
+  --scalar-api-client-text-lg: 18px;
+
+  /** Colors */
+  --scalar-api-client-background-primary: #fff;
+  --scalar-api-client-background-secondary: #f1f3f5;
+  --scalar-api-client-background-input: #fff;
+  --scalar-api-client-border-color: #dee2e6;
+
+  /** Borders */
+  --scalar-api-client-border: 1px solid var(--scalar-api-client-border-color);
+  --scalar-api-client-rounded: 4px;
+
+  /** Fonts */
+  --scalar-api-client-font-sans: system-ui, 'Segoe UI', Roboto, Helvetica, Arial,
+    sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol';
+  --scalar-api-client-font-mono: ui-monospace, Menlo, Monaco, 'Cascadia Mono',
+    'Segoe UI Mono', 'Roboto Mono', 'Oxygen Mono', 'Ubuntu Monospace',
+    'Source Code Pro', 'Fira Mono', 'Droid Sans Mono', 'Courier New', monospace;
+
+  /** Font weights */
+  --scalar-api-client-font-semibold: 600;
+  --scalar-api-client-font-bold: 700;
+
+  /** TODO: Go through the following variables and check what they do */
+  --scalar-api-client-post-color: white;
+  --scalar-api-client-post-background: black;
+  --scalar-api-client-delete-color: white;
+  --scalar-api-client-delete-background: black;
+  --scalar-api-client-patch-color: white;
+  --scalar-api-client-patch-background: black;
+  --scalar-api-client-get-color: #0ca678;
+  --scalar-api-client-get-background: white;
+  --scalar-api-client-put-color: white;
+  --scalar-api-client-put-background: black;
+  --scalar-api-client-color-3: #868e96;
+  /* Font color */
+  --scalar-api-client-theme-color-1: #343a40;
+  /* Select font color */
+  --scalar-api-client-theme-color-2: #868e96;
+  --scalar-api-client-theme-shadow-2: 0 0 0 1px white;
+  --scalar-api-client-fill: black;
+  --scalar-api-client-color2: white;
+  --scalar-api-client-bg3: black;
+  --scalar-api-client-gradient: linear-gradient(180deg, black 0%, black 100%);
+  /** Select background */
+  --scalar-api-client-background-3: #f8f9fa;
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@scalar/api-client",
+  "version": "0.1.1",
+  "author": "Scalar",
+  "license": "UNLICENSED",
+  "engines": {
+    "node": ">=18"
+  },
+  "type": "module",
+  "main": "src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@codemirror/lang-javascript": "6.1.9",
+    "@codemirror/lang-json": "6.0.1",
+    "@codemirror/state": "6.2.1",
+    "@codemirror/view": "6.16.0",
+    "@headlessui/vue": "1.7.14",
+    "@lezer/highlight": "1.1.6",
+    "@types/nunjucks": "3.2.2",
+    "@uiw/codemirror-theme-duotone": "4.21.3",
+    "@uiw/codemirror-themes": "4.21.3",
+    "@vueuse/core": "10.1.2",
+    "axios": "1.4.0",
+    "codemirror": "6.0.1",
+    "javascript-time-ago": "2.5.9",
+    "nanoid": "4.0.2",
+    "nunjucks": "3.2.4",
+    "pretty-bytes": "6.1.0",
+    "pretty-ms": "8.0.0",
+    "tippy.js": "6.3.7",
+    "@scalar/use-codemirror": "0.1.1",
+    "@scalar/use-keyboard-event": "0.1.1"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "4.2.3",
+    "tsc-alias": "1.8.6",
+    "vite": "4.4.8",
+    "vitest": "0.34.1",
+    "vue-tsc": "1.8.8"
+  },
+  "peerDependencies": {
+    "vue": "3.3.4"
+  },
+  "scripts": {
+    "build": "vite build && pnpm types:build && tsc-alias -p tsconfig.build.json",
+    "dev": "vite",
+    "lint:check": "eslint .",
+    "lint:fix": "eslint .  --fix",
+    "preview": "vite preview",
+    "test": "vitest",
+    "types:build": "vue-tsc -p tsconfig.build.json",
+    "types:check": "vue-tsc --noEmit --skipLibCheck"
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+export { ApiClient } from './components/ApiClient'
+
+export * from './helpers'
+export * from './hooks'
+export * from './stores/apiClientStore'
+export * from './stores/apiClientRequestStore'
+export * from './types'
+export * from './fixtures'