@mugwork/mug 0.1.0

package/dist/src/connector-service/spec-storage.js

@@ -0,0 +1,48 @@
+import { readFileSync, writeFileSync, mkdirSync, existsSync, readdirSync } from "node:fs";
+import { join } from "node:path";
+import { parse as yamlParse, stringify as yamlStringify } from "yaml";
+function specsDir(workspaceRoot) {
+    return join(workspaceRoot, "src", "connectors", ".specs");
+}
+function slugDir(workspaceRoot, slug) {
+    return join(specsDir(workspaceRoot), slug);
+}
+export function ensureSpecDir(workspaceRoot, slug) {
+    const dir = slugDir(workspaceRoot, slug);
+    mkdirSync(dir, { recursive: true });
+    return dir;
+}
+export function readMeta(workspaceRoot, slug) {
+    const path = join(slugDir(workspaceRoot, slug), "meta.yaml");
+    if (!existsSync(path))
+        return null;
+    return yamlParse(readFileSync(path, "utf-8"));
+}
+export function writeMeta(workspaceRoot, slug, meta) {
+    const dir = ensureSpecDir(workspaceRoot, slug);
+    writeFileSync(join(dir, "meta.yaml"), yamlStringify(meta));
+}
+export function readSpec(workspaceRoot, slug) {
+    const path = join(slugDir(workspaceRoot, slug), "openapi.yaml");
+    if (!existsSync(path))
+        return null;
+    return yamlParse(readFileSync(path, "utf-8"));
+}
+export function writeSpec(workspaceRoot, slug, spec) {
+    const dir = ensureSpecDir(workspaceRoot, slug);
+    writeFileSync(join(dir, "openapi.yaml"), yamlStringify(spec));
+}
+export function listSpecs(workspaceRoot) {
+    const dir = specsDir(workspaceRoot);
+    if (!existsSync(dir))
+        return [];
+    return readdirSync(dir, { withFileTypes: true })
+        .filter((d) => d.isDirectory())
+        .map((d) => d.name);
+}
+export function slugify(name) {
+    return name
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, "-")
+        .replace(/^-|-$/g, "");
+}

package/dist/src/connector-service/types.d.ts

@@ -0,0 +1,57 @@
+export interface XMugPagination {
+    style: "cursor" | "offset" | "page" | "link-header";
+    cursorParam?: string;
+    cursorPath?: string;
+    offsetParam?: string;
+    pageParam?: string;
+    pageSizeParam?: string;
+    defaultPageSize?: number;
+    maxPageSize?: number;
+}
+export interface XMugRateLimits {
+    requestsPerSecond?: number;
+    requestsPerMinute?: number;
+    headerLimit?: string;
+    headerRemaining?: string;
+    headerReset?: string;
+    resetFormat?: "unix" | "seconds" | "iso8601";
+    retryAfterHeader?: string;
+}
+export interface XMugSync {
+    supportsIncrementalSync: boolean;
+    filterParam?: string;
+    filterFormat?: "iso8601" | "unix" | "epoch_ms";
+    sortParam?: string;
+    sortValue?: string;
+    updatedAtField?: string;
+    deletedAtField?: string;
+    isDeletedField?: string;
+    deletionStrategy?: "soft-delete-field" | "tombstone-endpoint" | "full-sync-only";
+}
+export interface XMugQuirks {
+    description: string;
+    workaround?: string;
+    affectedEndpoints?: string[];
+}
+export type ApiType = "rest" | "graphql" | "soap" | "grpc" | "websocket" | "unknown";
+export type ApiTier = 1 | 2 | 3;
+export interface AuthConfig {
+    type: "api-key" | "oauth2" | "bearer" | "basic" | "custom";
+    headerName?: string;
+    tokenUrl?: string;
+    scopes?: string[];
+    notes?: string;
+}
+export interface ApiMetadata {
+    name: string;
+    slug: string;
+    hasApi: boolean;
+    apiType: ApiType;
+    docsUrl?: string;
+    openapiSpecUrl?: string;
+    auth?: AuthConfig;
+    tier: ApiTier;
+    alternatives?: string[];
+    lastVerified?: string;
+    notes?: string;
+}

package/dist/src/connector-service/types.js

@@ -0,0 +1,2 @@
+// x-mug-* OpenAPI extension types and metadata schemas
+export {};

package/dist/src/connector-service/verify.d.ts

@@ -0,0 +1,24 @@
+export interface ConnectionConfig {
+    auth: {
+        type: "api-key" | "bearer" | "basic" | "oauth2";
+        header?: string;
+        prefix?: string;
+        value: string;
+        tokenUrl?: string;
+        refreshToken?: string;
+    };
+    baseUrl?: string;
+}
+export interface ProbeResult {
+    probe: string;
+    status: "pass" | "fail" | "skip" | "partial";
+    summary: string;
+    details: Record<string, unknown>;
+}
+export interface VerifyResult {
+    slug: string;
+    probes: ProbeResult[];
+    enrichedSpecSaved: boolean;
+    overallStatus: "pass" | "partial" | "fail";
+}
+export declare function verify(workspaceRoot: string, slug: string, sourceName: string): Promise<VerifyResult>;