@yaakapp/api 0.0.1

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,9 @@
+"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.d.ts

@@ -0,0 +1,116 @@
+export interface BaseModel {
+    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.js

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

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@yaakapp/api",
+  "version": "0.0.1",
+  "main": "lib/index.js",
+  "typings": "./lib/index.d.ts",
+  "scripts": {
+    "prepublish": "tsc"
+  },
+  "dependencies": {
+    "@types/node": "^22.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.4"
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import { PathOrFileDescriptor, readFileSync } from 'node:fs';
+
+export type * from './models';
+
+export function sayHi(name: PathOrFileDescriptor) {
+  console.log('Hello', name);
+  readFileSync('');
+}

package/src/models.ts

@@ -0,0 +1,134 @@
+export interface BaseModel {
+  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/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "module": "node16",
+    "target": "es6",
+    "lib": ["es2021"],
+    "declaration": true,
+    "declarationDir": "./lib",
+    "outDir": "./lib",
+    "strict": true,
+    "types": ["node"]
+  },
+  "files": [
+    "src/index.ts"
+  ]
+}