@yaakapp/api 0.0.4 → 0.0.5

package/lib/helpers.d.ts

@@ -0,0 +1,2 @@
+export type AtLeast<T, K extends keyof T> = Partial<T> & Pick<T, K>;
+export type SingleOrArray<T> = T[] | T;

package/lib/helpers.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
-import { PathOrFileDescriptor } from 'node:fs';
 export type * from './models';
-export declare function sayHi(name: PathOrFileDescriptor): void;
+export type * from './plugins';
+export type * from './themes';

package/lib/index.js

@@ -1,9 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sayHi = void 0;
-const node_fs_1 = require("node:fs");
-function sayHi(name) {
-    console.log('Hello', name);
-    (0, node_fs_1.readFileSync)('');
-}
-exports.sayHi = sayHi;

package/lib/models/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/lib/models/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

package/lib/models/types.d.ts

@@ -0,0 +1,117 @@
+export interface BaseModel {
+    readonly model: string;
+    readonly id: string;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+export interface Workspace extends BaseModel {
+    readonly model: 'workspace';
+    name: string;
+    description: string;
+    variables: EnvironmentVariable[];
+    settingValidateCertificates: boolean;
+    settingFollowRedirects: boolean;
+    settingRequestTimeout: number;
+}
+export interface EnvironmentVariable {
+    name: string;
+    value: string;
+    enabled?: boolean;
+}
+export interface Folder extends BaseModel {
+    readonly workspaceId: string;
+    readonly model: 'folder';
+    folderId: string | null;
+    sortPriority: number;
+    name: string;
+}
+export interface Environment extends BaseModel {
+    readonly workspaceId: string;
+    readonly model: 'environment';
+    name: string;
+    variables: EnvironmentVariable[];
+}
+export interface HttpHeader {
+    name: string;
+    value: string;
+    enabled?: boolean;
+}
+export interface HttpUrlParameter {
+    name: string;
+    value: string;
+    enabled?: boolean;
+}
+export interface GrpcMetadataEntry {
+    name: string;
+    value: string;
+    enabled?: boolean;
+}
+export interface GrpcRequest extends BaseModel {
+    readonly workspaceId: string;
+    readonly model: 'grpc_request';
+    folderId: string | null;
+    sortPriority: number;
+    name: string;
+    url: string;
+    service: string | null;
+    method: string | null;
+    message: string;
+    authentication: Record<string, string | number | boolean | null | undefined>;
+    authenticationType: string | null;
+    metadata: GrpcMetadataEntry[];
+}
+export interface GrpcEvent extends BaseModel {
+    readonly workspaceId: string;
+    readonly requestId: string;
+    readonly connectionId: string;
+    readonly model: 'grpc_event';
+    content: string;
+    status: number | null;
+    error: string | null;
+    eventType: 'info' | 'error' | 'client_message' | 'server_message' | 'connection_start' | 'connection_end';
+    metadata: Record<string, string>;
+}
+export interface GrpcConnection extends BaseModel {
+    readonly workspaceId: string;
+    readonly requestId: string;
+    readonly model: 'grpc_connection';
+    service: string;
+    method: string;
+    elapsed: number;
+    elapsedConnection: number;
+    status: number;
+    url: string;
+    error: string | null;
+    trailers: Record<string, string>;
+}
+export interface HttpRequest extends BaseModel {
+    readonly workspaceId: string;
+    readonly model: 'http_request';
+    folderId: string | null;
+    sortPriority: number;
+    name: string;
+    url: string;
+    urlParameters: HttpUrlParameter[];
+    body: Record<string, unknown>;
+    bodyType: string | null;
+    authentication: Record<string, string | number | boolean | null | undefined>;
+    authenticationType: string | null;
+    method: string;
+    headers: HttpHeader[];
+}
+export interface HttpResponse extends BaseModel {
+    readonly workspaceId: string;
+    readonly model: 'http_response';
+    readonly requestId: string;
+    readonly bodyPath: string | null;
+    readonly contentLength: number | null;
+    readonly error: string;
+    readonly status: number;
+    readonly elapsed: number;
+    readonly elapsedHeaders: number;
+    readonly statusReason: string;
+    readonly version: string;
+    readonly remoteAddr: string;
+    readonly url: string;
+    readonly headers: HttpHeader[];
+}

package/lib/models/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/context.d.ts

@@ -0,0 +1,10 @@
+import { HttpRequest, HttpResponse } from '../models';
+export type YaakContext = {
+    metadata: {
+        getVersion(): Promise<string>;
+    };
+    httpRequest: {
+        send(id: string): Promise<HttpResponse>;
+        getById(id: string): Promise<HttpRequest | null>;
+    };
+};

package/lib/plugins/context.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/import.d.ts

@@ -0,0 +1,14 @@
+import { AtLeast } from '../helpers';
+import { Environment, Folder, HttpRequest, Workspace } from '../models';
+import { YaakContext } from './context';
+export type ImportPluginResponse = {
+    resources: Partial<{
+        workspaces: AtLeast<Workspace, 'name' | 'id' | 'model'>[];
+        environments: AtLeast<Environment, 'name' | 'id' | 'model' | 'workspaceId'>[];
+        httpRequests: AtLeast<HttpRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
+        folders: AtLeast<Folder, 'name' | 'id' | 'model' | 'workspaceId'>[];
+    }>;
+};
+export type ImporterPlugin = {
+    onImport(ctx: YaakContext, fileContents: string): Promise<ImportPluginResponse>;
+};

package/lib/plugins/import.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/index.d.ts

@@ -0,0 +1,12 @@
+import { SingleOrArray } from '../helpers';
+import { ImporterPlugin } from './import';
+import { ThemePlugin } from './theme';
+/**
+ * The global structure of a Yaak plugin
+ */
+export type YaakPlugin = {
+    /** One or many plugins to import data into Yaak */
+    importers: SingleOrArray<ImporterPlugin>;
+    /** One or many themes to customize the Yaak UI */
+    themes: SingleOrArray<ThemePlugin>;
+};

package/lib/plugins/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/theme.d.ts

@@ -0,0 +1,4 @@
+import { Theme } from '../themes';
+export type ThemePlugin = {
+    theme: Theme;
+};

package/lib/plugins/theme.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/themes/index.d.ts

@@ -0,0 +1,39 @@
+export type Colors = {
+    surface: string;
+    surfaceHighlight?: string;
+    surfaceActive?: string;
+    text: string;
+    textSubtle?: string;
+    textSubtlest?: string;
+    border?: string;
+    borderSubtle?: string;
+    borderFocus?: string;
+    shadow?: string;
+    backdrop?: string;
+    selection?: string;
+    primary?: string;
+    secondary?: string;
+    info?: string;
+    success?: string;
+    notice?: string;
+    warning?: string;
+    danger?: string;
+};
+export type Theme = Colors & {
+    id: string;
+    name: string;
+    components?: Partial<{
+        dialog: Partial<Colors>;
+        menu: Partial<Colors>;
+        toast: Partial<Colors>;
+        sidebar: Partial<Colors>;
+        responsePane: Partial<Colors>;
+        appHeader: Partial<Colors>;
+        button: Partial<Colors>;
+        banner: Partial<Colors>;
+        placeholder: Partial<Colors>;
+        urlBar: Partial<Colors>;
+        editor: Partial<Colors>;
+        input: Partial<Colors>;
+    }>;
+};

package/lib/themes/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [