@intlayer/backend-contract 0.0.0-stage → 9.6.0

package/dist/types/showcaseProject.d.ts

@@ -0,0 +1,550 @@
+import { RouteBodyInput, RouteDefinition, RouteGroup, RouteParams, RouteQuerystring } from "./defineRoute.js";
+import { PaginatedResponse, ResponseData } from "./responseData.js";
+import { z } from "zod/mini";
+//#region src/showcaseProject.d.ts
+/** Votes of a showcase project, with the session's own vote. */
+declare const votesSchema: z.ZodMiniObject<{
+  upvotes: z.ZodMiniNumber<number>;
+  isUpVoted: z.ZodMiniBoolean<boolean>;
+  downvotes: z.ZodMiniNumber<number>;
+  isDownVoted: z.ZodMiniBoolean<boolean>;
+}, z.core.$strip>;
+/** i18n SEO checks run on the showcased website. */
+export declare const showcaseScanDetailsSchema: z.ZodMiniObject<{
+  score: z.ZodMiniNumber<number>;
+  langTag: z.ZodMiniString<string>;
+  htmlDir: z.ZodMiniString<string>;
+  hreflangs: z.ZodMiniArray<z.ZodMiniString<string>>;
+  hasXDefault: z.ZodMiniBoolean<boolean>;
+  hasCanonical: z.ZodMiniBoolean<boolean>;
+  hasLocalizedLinks: z.ZodMiniBoolean<boolean>;
+  allAnchorsLocalized: z.ZodMiniBoolean<boolean>;
+  robotsTxt: z.ZodMiniObject<{
+    accessible: z.ZodMiniBoolean<boolean>;
+    disallowWithoutLocaleAlternates: z.ZodMiniBoolean<boolean>;
+  }, z.core.$strip>;
+  sitemapXml: z.ZodMiniObject<{
+    urlsDiscoveredCount: z.ZodMiniNumber<number>;
+    alternatesPresent: z.ZodMiniBoolean<boolean>;
+    xDefaultPresent: z.ZodMiniBoolean<boolean>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+/** Showcase project as returned by the API. */
+export declare const showcaseProjectSchema: z.ZodMiniObject<{
+  upvotes: z.ZodMiniNumber<number>;
+  isUpVoted: z.ZodMiniBoolean<boolean>;
+  downvotes: z.ZodMiniNumber<number>;
+  isDownVoted: z.ZodMiniBoolean<boolean>;
+  id: z.ZodMiniString<string>;
+  title: z.ZodMiniString<string>;
+  description: z.ZodMiniString<string>;
+  imageUrl: z.ZodMiniString<string>;
+  logoUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  websiteUrl: z.ZodMiniString<string>;
+  githubUrl: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+  tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+  isOpenSource: z.ZodMiniBoolean<boolean>;
+  intlayerVersion: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  libsUsed: z.ZodMiniArray<z.ZodMiniString<string>>;
+  packageDetails: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+  lastScanDate: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  scanDetails: z.ZodMiniOptional<z.ZodMiniObject<{
+    score: z.ZodMiniNumber<number>;
+    langTag: z.ZodMiniString<string>;
+    htmlDir: z.ZodMiniString<string>;
+    hreflangs: z.ZodMiniArray<z.ZodMiniString<string>>;
+    hasXDefault: z.ZodMiniBoolean<boolean>;
+    hasCanonical: z.ZodMiniBoolean<boolean>;
+    hasLocalizedLinks: z.ZodMiniBoolean<boolean>;
+    allAnchorsLocalized: z.ZodMiniBoolean<boolean>;
+    robotsTxt: z.ZodMiniObject<{
+      accessible: z.ZodMiniBoolean<boolean>;
+      disallowWithoutLocaleAlternates: z.ZodMiniBoolean<boolean>;
+    }, z.core.$strip>;
+    sitemapXml: z.ZodMiniObject<{
+      urlsDiscoveredCount: z.ZodMiniNumber<number>;
+      alternatesPresent: z.ZodMiniBoolean<boolean>;
+      xDefaultPresent: z.ZodMiniBoolean<boolean>;
+    }, z.core.$strip>;
+  }, z.core.$strip>>;
+  owner: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  status: z.ZodMiniOptional<z.ZodMiniEnum<{
+    active: "active";
+    pending_scan: "pending_scan";
+    scan_failed: "scan_failed";
+  }>>;
+  createdAt: z.ZodMiniString<string>;
+  isOwner: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+}, z.core.$loose>;
+/** REST contract of the `/api/showcase-project` routes. */
+export declare const showcaseProjectContract: RouteGroup<"/api/showcase-project", {
+  readonly getShowcaseProjects: RouteDefinition<"GET", "/", {
+    readonly querystring: z.ZodMiniObject<{
+      page: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniNumber<number>]>>;
+      pageSize: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniNumber<number>]>>;
+      search: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      selectedUseCases: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+      isOpenSource: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+          upvotes: z.ZodMiniNumber<number>;
+          isUpVoted: z.ZodMiniBoolean<boolean>;
+          downvotes: z.ZodMiniNumber<number>;
+          isDownVoted: z.ZodMiniBoolean<boolean>;
+          id: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          description: z.ZodMiniString<string>;
+          imageUrl: z.ZodMiniString<string>;
+          logoUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          websiteUrl: z.ZodMiniString<string>;
+          githubUrl: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+          tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+          isOpenSource: z.ZodMiniBoolean<boolean>;
+          intlayerVersion: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          libsUsed: z.ZodMiniArray<z.ZodMiniString<string>>;
+          packageDetails: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+          lastScanDate: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          scanDetails: z.ZodMiniOptional<z.ZodMiniObject<{
+            score: z.ZodMiniNumber<number>;
+            langTag: z.ZodMiniString<string>;
+            htmlDir: z.ZodMiniString<string>;
+            hreflangs: z.ZodMiniArray<z.ZodMiniString<string>>;
+            hasXDefault: z.ZodMiniBoolean<boolean>;
+            hasCanonical: z.ZodMiniBoolean<boolean>;
+            hasLocalizedLinks: z.ZodMiniBoolean<boolean>;
+            allAnchorsLocalized: z.ZodMiniBoolean<boolean>;
+            robotsTxt: z.ZodMiniObject<{
+              accessible: z.ZodMiniBoolean<boolean>;
+              disallowWithoutLocaleAlternates: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+            sitemapXml: z.ZodMiniObject<{
+              urlsDiscoveredCount: z.ZodMiniNumber<number>;
+              alternatesPresent: z.ZodMiniBoolean<boolean>;
+              xDefaultPresent: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+          }, z.core.$strip>>;
+          owner: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          status: z.ZodMiniOptional<z.ZodMiniEnum<{
+            active: "active";
+            pending_scan: "pending_scan";
+            scan_failed: "scan_failed";
+          }>>;
+          createdAt: z.ZodMiniString<string>;
+          isOwner: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+        }, z.core.$loose>>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+        page: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+        page_size: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+        total_pages: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+        total_items: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly submitShowcaseProject: RouteDefinition<"POST", "/submit", {
+    readonly body: z.ZodMiniObject<{
+      name: z.ZodMiniString<string>;
+      url: z.ZodMiniURL;
+      githubUrl: z.ZodMiniPipe<z.ZodMiniUnion<readonly [z.ZodMiniOptional<z.ZodMiniURL>, z.ZodMiniLiteral<"">]>, z.ZodMiniTransform<string, string>>;
+      useCases: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          upvotes: z.ZodMiniNumber<number>;
+          isUpVoted: z.ZodMiniBoolean<boolean>;
+          downvotes: z.ZodMiniNumber<number>;
+          isDownVoted: z.ZodMiniBoolean<boolean>;
+          id: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          description: z.ZodMiniString<string>;
+          imageUrl: z.ZodMiniString<string>;
+          logoUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          websiteUrl: z.ZodMiniString<string>;
+          githubUrl: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+          tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+          isOpenSource: z.ZodMiniBoolean<boolean>;
+          intlayerVersion: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          libsUsed: z.ZodMiniArray<z.ZodMiniString<string>>;
+          packageDetails: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+          lastScanDate: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          scanDetails: z.ZodMiniOptional<z.ZodMiniObject<{
+            score: z.ZodMiniNumber<number>;
+            langTag: z.ZodMiniString<string>;
+            htmlDir: z.ZodMiniString<string>;
+            hreflangs: z.ZodMiniArray<z.ZodMiniString<string>>;
+            hasXDefault: z.ZodMiniBoolean<boolean>;
+            hasCanonical: z.ZodMiniBoolean<boolean>;
+            hasLocalizedLinks: z.ZodMiniBoolean<boolean>;
+            allAnchorsLocalized: z.ZodMiniBoolean<boolean>;
+            robotsTxt: z.ZodMiniObject<{
+              accessible: z.ZodMiniBoolean<boolean>;
+              disallowWithoutLocaleAlternates: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+            sitemapXml: z.ZodMiniObject<{
+              urlsDiscoveredCount: z.ZodMiniNumber<number>;
+              alternatesPresent: z.ZodMiniBoolean<boolean>;
+              xDefaultPresent: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+          }, z.core.$strip>>;
+          owner: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          status: z.ZodMiniOptional<z.ZodMiniEnum<{
+            active: "active";
+            pending_scan: "pending_scan";
+            scan_failed: "scan_failed";
+          }>>;
+          createdAt: z.ZodMiniString<string>;
+          isOwner: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+        }, z.core.$loose>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly getOtherShowcaseProjects: RouteDefinition<"GET", "/others", {
+    readonly querystring: z.ZodMiniObject<{
+      excludeId: z.ZodMiniString<string>;
+      limit: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+          upvotes: z.ZodMiniNumber<number>;
+          isUpVoted: z.ZodMiniBoolean<boolean>;
+          downvotes: z.ZodMiniNumber<number>;
+          isDownVoted: z.ZodMiniBoolean<boolean>;
+          id: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          description: z.ZodMiniString<string>;
+          imageUrl: z.ZodMiniString<string>;
+          logoUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          websiteUrl: z.ZodMiniString<string>;
+          githubUrl: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+          tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+          isOpenSource: z.ZodMiniBoolean<boolean>;
+          intlayerVersion: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          libsUsed: z.ZodMiniArray<z.ZodMiniString<string>>;
+          packageDetails: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+          lastScanDate: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          scanDetails: z.ZodMiniOptional<z.ZodMiniObject<{
+            score: z.ZodMiniNumber<number>;
+            langTag: z.ZodMiniString<string>;
+            htmlDir: z.ZodMiniString<string>;
+            hreflangs: z.ZodMiniArray<z.ZodMiniString<string>>;
+            hasXDefault: z.ZodMiniBoolean<boolean>;
+            hasCanonical: z.ZodMiniBoolean<boolean>;
+            hasLocalizedLinks: z.ZodMiniBoolean<boolean>;
+            allAnchorsLocalized: z.ZodMiniBoolean<boolean>;
+            robotsTxt: z.ZodMiniObject<{
+              accessible: z.ZodMiniBoolean<boolean>;
+              disallowWithoutLocaleAlternates: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+            sitemapXml: z.ZodMiniObject<{
+              urlsDiscoveredCount: z.ZodMiniNumber<number>;
+              alternatesPresent: z.ZodMiniBoolean<boolean>;
+              xDefaultPresent: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+          }, z.core.$strip>>;
+          owner: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          status: z.ZodMiniOptional<z.ZodMiniEnum<{
+            active: "active";
+            pending_scan: "pending_scan";
+            scan_failed: "scan_failed";
+          }>>;
+          createdAt: z.ZodMiniString<string>;
+          isOwner: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+        }, z.core.$loose>>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly toggleShowcaseUpvote: RouteDefinition<"POST", "/upvote", {
+    readonly body: z.ZodMiniObject<{
+      projectId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          upvotes: z.ZodMiniNumber<number>;
+          isUpVoted: z.ZodMiniBoolean<boolean>;
+          downvotes: z.ZodMiniNumber<number>;
+          isDownVoted: z.ZodMiniBoolean<boolean>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly toggleShowcaseDownvote: RouteDefinition<"POST", "/downvote", {
+    readonly body: z.ZodMiniObject<{
+      projectId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          upvotes: z.ZodMiniNumber<number>;
+          isUpVoted: z.ZodMiniBoolean<boolean>;
+          downvotes: z.ZodMiniNumber<number>;
+          isDownVoted: z.ZodMiniBoolean<boolean>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly getShowcaseProjectById: RouteDefinition<"GET", "/:projectId", {
+    readonly params: z.ZodMiniObject<{
+      projectId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          upvotes: z.ZodMiniNumber<number>;
+          isUpVoted: z.ZodMiniBoolean<boolean>;
+          downvotes: z.ZodMiniNumber<number>;
+          isDownVoted: z.ZodMiniBoolean<boolean>;
+          id: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          description: z.ZodMiniString<string>;
+          imageUrl: z.ZodMiniString<string>;
+          logoUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          websiteUrl: z.ZodMiniString<string>;
+          githubUrl: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+          tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+          isOpenSource: z.ZodMiniBoolean<boolean>;
+          intlayerVersion: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          libsUsed: z.ZodMiniArray<z.ZodMiniString<string>>;
+          packageDetails: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+          lastScanDate: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          scanDetails: z.ZodMiniOptional<z.ZodMiniObject<{
+            score: z.ZodMiniNumber<number>;
+            langTag: z.ZodMiniString<string>;
+            htmlDir: z.ZodMiniString<string>;
+            hreflangs: z.ZodMiniArray<z.ZodMiniString<string>>;
+            hasXDefault: z.ZodMiniBoolean<boolean>;
+            hasCanonical: z.ZodMiniBoolean<boolean>;
+            hasLocalizedLinks: z.ZodMiniBoolean<boolean>;
+            allAnchorsLocalized: z.ZodMiniBoolean<boolean>;
+            robotsTxt: z.ZodMiniObject<{
+              accessible: z.ZodMiniBoolean<boolean>;
+              disallowWithoutLocaleAlternates: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+            sitemapXml: z.ZodMiniObject<{
+              urlsDiscoveredCount: z.ZodMiniNumber<number>;
+              alternatesPresent: z.ZodMiniBoolean<boolean>;
+              xDefaultPresent: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+          }, z.core.$strip>>;
+          owner: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          status: z.ZodMiniOptional<z.ZodMiniEnum<{
+            active: "active";
+            pending_scan: "pending_scan";
+            scan_failed: "scan_failed";
+          }>>;
+          createdAt: z.ZodMiniString<string>;
+          isOwner: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+        }, z.core.$loose>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly scanShowcaseProject: RouteDefinition<"GET", "/:projectId/scan", {
+    readonly params: z.ZodMiniObject<{
+      projectId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+  }>;
+  readonly deleteShowcaseProject: RouteDefinition<"DELETE", "/:projectId", {
+    readonly params: z.ZodMiniObject<{
+      projectId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          success: z.ZodMiniBoolean<boolean>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly updateShowcaseProject: RouteDefinition<"PATCH", "/:projectId", {
+    readonly params: z.ZodMiniObject<{
+      projectId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly body: z.ZodMiniObject<{
+      name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      url: z.ZodMiniOptional<z.ZodMiniURL>;
+      githubUrl: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<string, string>>;
+      tagline: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      useCases: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          upvotes: z.ZodMiniNumber<number>;
+          isUpVoted: z.ZodMiniBoolean<boolean>;
+          downvotes: z.ZodMiniNumber<number>;
+          isDownVoted: z.ZodMiniBoolean<boolean>;
+          id: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          description: z.ZodMiniString<string>;
+          imageUrl: z.ZodMiniString<string>;
+          logoUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          websiteUrl: z.ZodMiniString<string>;
+          githubUrl: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+          tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+          isOpenSource: z.ZodMiniBoolean<boolean>;
+          intlayerVersion: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          libsUsed: z.ZodMiniArray<z.ZodMiniString<string>>;
+          packageDetails: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>>;
+          lastScanDate: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          scanDetails: z.ZodMiniOptional<z.ZodMiniObject<{
+            score: z.ZodMiniNumber<number>;
+            langTag: z.ZodMiniString<string>;
+            htmlDir: z.ZodMiniString<string>;
+            hreflangs: z.ZodMiniArray<z.ZodMiniString<string>>;
+            hasXDefault: z.ZodMiniBoolean<boolean>;
+            hasCanonical: z.ZodMiniBoolean<boolean>;
+            hasLocalizedLinks: z.ZodMiniBoolean<boolean>;
+            allAnchorsLocalized: z.ZodMiniBoolean<boolean>;
+            robotsTxt: z.ZodMiniObject<{
+              accessible: z.ZodMiniBoolean<boolean>;
+              disallowWithoutLocaleAlternates: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+            sitemapXml: z.ZodMiniObject<{
+              urlsDiscoveredCount: z.ZodMiniNumber<number>;
+              alternatesPresent: z.ZodMiniBoolean<boolean>;
+              xDefaultPresent: z.ZodMiniBoolean<boolean>;
+            }, z.core.$strip>;
+          }, z.core.$strip>>;
+          owner: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          status: z.ZodMiniOptional<z.ZodMiniEnum<{
+            active: "active";
+            pending_scan: "pending_scan";
+            scan_failed: "scan_failed";
+          }>>;
+          createdAt: z.ZodMiniString<string>;
+          isOwner: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+        }, z.core.$loose>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+}>;
+/** Route definitions of the `/api/showcase-project` group, by name. */
+export type ShowcaseProjectRoutes = (typeof showcaseProjectContract)['routes'];
+type ShowcaseVotes = z.output<typeof votesSchema>;
+export type ShowcaseScanDetails = z.output<typeof showcaseScanDetailsSchema>;
+export type ShowcaseProjectAPI = z.output<typeof showcaseProjectSchema>;
+export type GetShowcaseProjectsQuery = RouteQuerystring<ShowcaseProjectRoutes['getShowcaseProjects']>;
+export type GetShowcaseProjectsResult = PaginatedResponse<ShowcaseProjectAPI>;
+export type SubmitShowcaseProjectBody = RouteBodyInput<ShowcaseProjectRoutes['submitShowcaseProject']>;
+export type SubmitShowcaseProjectResult = ResponseData<ShowcaseProjectAPI>;
+export type GetOtherShowcaseProjectsQuery = RouteQuerystring<ShowcaseProjectRoutes['getOtherShowcaseProjects']>;
+export type GetOtherShowcaseProjectsResult = ResponseData<ShowcaseProjectAPI[]>;
+export type ToggleShowcaseUpvoteBody = RouteBodyInput<ShowcaseProjectRoutes['toggleShowcaseUpvote']>;
+export type ToggleShowcaseUpvoteResult = ResponseData<ShowcaseVotes>;
+export type ToggleShowcaseDownvoteBody = RouteBodyInput<ShowcaseProjectRoutes['toggleShowcaseDownvote']>;
+export type ToggleShowcaseDownvoteResult = ResponseData<ShowcaseVotes>;
+export type GetShowcaseProjectByIdParams = RouteParams<ShowcaseProjectRoutes['getShowcaseProjectById']>;
+export type GetShowcaseProjectByIdResult = ResponseData<ShowcaseProjectAPI>;
+export type UpdateShowcaseProjectParams = RouteParams<ShowcaseProjectRoutes['updateShowcaseProject']>;
+export type UpdateShowcaseProjectBody = RouteBodyInput<ShowcaseProjectRoutes['updateShowcaseProject']>;
+export type UpdateShowcaseProjectResult = ResponseData<ShowcaseProjectAPI>;
+export type DeleteShowcaseProjectParams = RouteParams<ShowcaseProjectRoutes['deleteShowcaseProject']>;
+//#endregion
+//# sourceMappingURL=showcaseProject.d.ts.map

package/dist/types/showcaseProject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"showcaseProject.d.ts","names":[],"sources":["../../src/showcaseProject.ts"],"mappings":";;;;;cAwCM,aAAW,EAAA;;;;;GAKf,EAAA,KAAA;;qBAGW,2BAAyB,EAAA;;;;;;;;;;;;;;;;;;GAkBpC,EAAA,KAAA;;qBAGW,uBAAqB,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoBhC,EAAA,KAAA;;qBAMW;gCAeU;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAcA;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCAaV;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAUU;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;mCASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;mCASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAkBV;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;kCA6BU;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAOX,gCAAgC;KAEvC,gBAAgB,EAAE,cAAc;YAEzB,sBAAsB,EAAE,cAAc;YACtC,qBAAqB,EAAE,cAAc;YACrC,2BAA2B,iBACrC;YAEU,4BAA4B,kBAAkB;YAC9C,4BAA4B,eACtC;YAEU,8BAA8B,aAAa;YAC3C,gCAAgC,iBAC1C;YAEU,iCAAiC,aAAa;YAC9C,2BAA2B,eACrC;YAEU,6BAA6B,aAAa;YAC1C,6BAA6B,eACvC;YAEU,+BAA+B,aAAa;YAC5C,+BAA+B,YACzC;YAEU,+BAA+B,aAAa;YAC5C,8BAA8B,YACxC;YAEU,4BAA4B,eACtC;YAEU,8BAA8B,aAAa;YAC3C,8BAA8B,YACxC"}