apiskill 0.1.0

package/src/types.ts

@@ -0,0 +1,115 @@
+export type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head';
+
+export type SwaggerSchema = {
+  $ref?: string;
+  type?: string;
+  format?: string;
+  description?: string;
+  default?: unknown;
+  enum?: unknown[];
+  required?: string[];
+  properties?: Record<string, SwaggerSchema>;
+  items?: SwaggerSchema;
+  allOf?: SwaggerSchema[];
+  anyOf?: SwaggerSchema[];
+  oneOf?: SwaggerSchema[];
+  additionalProperties?: boolean | SwaggerSchema;
+  nullable?: boolean;
+  minimum?: number;
+  maximum?: number;
+};
+
+export type SwaggerParameter = {
+  name: string;
+  in: 'query' | 'header' | 'path' | 'cookie' | 'body' | 'formData';
+  description?: string;
+  required?: boolean;
+  schema?: SwaggerSchema;
+  type?: string;
+  format?: string;
+  default?: unknown;
+  enum?: unknown[];
+  items?: SwaggerSchema;
+};
+
+export type SwaggerMedia = {
+  schema?: SwaggerSchema;
+};
+
+export type SwaggerOperation = {
+  tags?: string[];
+  summary?: string;
+  description?: string;
+  operationId?: string;
+  consumes?: string[];
+  produces?: string[];
+  parameters?: SwaggerParameter[];
+  requestBody?: {
+    required?: boolean;
+    content?: Record<string, SwaggerMedia>;
+  };
+  responses?: Record<
+    string,
+    {
+      description?: string;
+      content?: Record<string, SwaggerMedia>;
+      schema?: SwaggerSchema;
+      responseSchema?: SwaggerSchema;
+    }
+  >;
+  'x-apiskill-links'?: EndpointAssociationLinks;
+};
+
+export type EndpointAssociatedLink = {
+  sourceType?: 'local' | 'online' | 'curl';
+  title?: string;
+  url?: string;
+  curl?: string;
+  authType?: 'none' | 'browser' | 'bearer' | 'header';
+  token?: string;
+  headerName?: string;
+  note?: string;
+};
+
+export type EndpointAssociationLinks = {
+  prototype?: EndpointAssociatedLink;
+  ui?: EndpointAssociatedLink;
+};
+
+export type SwaggerDocument = {
+  openapi?: string;
+  swagger?: string;
+  info?: {
+    title?: string;
+    version?: string;
+    description?: string;
+  };
+  paths?: Record<string, Partial<Record<HttpMethod, SwaggerOperation>>>;
+  components?: {
+    schemas?: Record<string, SwaggerSchema>;
+  };
+  definitions?: Record<string, SwaggerSchema>;
+};
+
+export type Endpoint = {
+  id: string;
+  path: string;
+  method: HttpMethod;
+  operation: SwaggerOperation;
+  tags: string[];
+  summary: string;
+  hasBody: boolean;
+  searchable: string;
+};
+
+export type FieldRow = {
+  name: string;
+  path: string;
+  location?: string;
+  required: boolean;
+  type: string;
+  description: string;
+  defaultValue: string;
+  enumValue: string;
+  depth: number;
+};

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["DOM", "DOM.Iterable", "ES2022"],
+    "allowJs": false,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx"
+  },
+  "include": ["src"],
+  "references": []
+}