@intlayer/backend-contract 0.0.0-stage → 9.6.0

package/dist/types/analytics.d.ts

@@ -0,0 +1,378 @@
+import { RouteBodyInput, RouteDefinition, RouteGroup } from "./defineRoute.js";
+import { ResponseData } from "./responseData.js";
+import { z } from "zod/mini";
+//#region src/analytics.d.ts
+/** Kind of analytics event sent by the SDK. */
+export declare const analyticsEventTypeSchema: z.ZodMiniEnum<{
+  content_exposure: "content_exposure";
+  conversion: "conversion";
+  page_view: "page_view";
+}>;
+/** One event as sent by the SDK (batched). */
+export declare const incomingAnalyticsEventSchema: z.ZodMiniObject<{
+  type: z.ZodMiniEnum<{
+    content_exposure: "content_exposure";
+    conversion: "conversion";
+    page_view: "page_view";
+  }>;
+  t: z.ZodMiniNumber<number>;
+  locale: z.ZodMiniString<string>;
+  url: z.ZodMiniString<string>;
+  ref: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  dictionaryKey: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  keyPath: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  nodeType: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  variant: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+  experimentKey: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  goal: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  value: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+}, z.core.$loose>;
+/** Time windows of the audience report. */
+export declare const audienceRangeSchema: z.ZodMiniEnum<{
+  "1h": "1h";
+  "1y": "1y";
+  "24h": "24h";
+  "30d": "30d";
+  "3y": "3y";
+  "6mo": "6mo";
+  "7d": "7d";
+  "90d": "90d";
+}>;
+export declare const audienceGranularitySchema: z.ZodMiniEnum<{
+  day: "day";
+  hour: "hour";
+  minute: "minute";
+  month: "month";
+  week: "week";
+}>;
+export declare const audienceSeriesPointSchema: z.ZodMiniObject<{
+  bucket: z.ZodMiniString<string>;
+  users: z.ZodMiniNumber<number>;
+  views: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+declare const audienceBreakdownRowSchema: z.ZodMiniObject<{
+  key: z.ZodMiniString<string>;
+  users: z.ZodMiniNumber<number>;
+  views: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+export declare const audienceStatsSchema: z.ZodMiniObject<{
+  usersToday: z.ZodMiniNumber<number>;
+  usersLast7Days: z.ZodMiniNumber<number>;
+  usersInRange: z.ZodMiniNumber<number>;
+  viewsInRange: z.ZodMiniNumber<number>;
+  range: z.ZodMiniEnum<{
+    "1h": "1h";
+    "1y": "1y";
+    "24h": "24h";
+    "30d": "30d";
+    "3y": "3y";
+    "6mo": "6mo";
+    "7d": "7d";
+    "90d": "90d";
+  }>;
+  rangeHours: z.ZodMiniNumber<number>;
+  granularity: z.ZodMiniEnum<{
+    day: "day";
+    hour: "hour";
+    minute: "minute";
+    month: "month";
+    week: "week";
+  }>;
+  series: z.ZodMiniArray<z.ZodMiniObject<{
+    bucket: z.ZodMiniString<string>;
+    users: z.ZodMiniNumber<number>;
+    views: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+  byLocale: z.ZodMiniArray<z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    users: z.ZodMiniNumber<number>;
+    views: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+  byCountry: z.ZodMiniArray<z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    users: z.ZodMiniNumber<number>;
+    views: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+  byPage: z.ZodMiniArray<z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    users: z.ZodMiniNumber<number>;
+    views: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const analyticsOverviewRowSchema: z.ZodMiniObject<{
+  url: z.ZodMiniString<string>;
+  locale: z.ZodMiniString<string>;
+  views: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+declare const contentStatRowSchema: z.ZodMiniObject<{
+  dictionaryKey: z.ZodMiniString<string>;
+  keyPath: z.ZodMiniString<string>;
+  locale: z.ZodMiniString<string>;
+  exposures: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+declare const experimentResultSchema: z.ZodMiniObject<{
+  experimentKey: z.ZodMiniString<string>;
+  variants: z.ZodMiniArray<z.ZodMiniObject<{
+    variant: z.ZodMiniString<string>;
+    exposures: z.ZodMiniNumber<number>;
+    conversions: z.ZodMiniNumber<number>;
+    conversionRate: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+  pValue: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+  winner: z.ZodMiniNullable<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+declare const pageMetadataSchema: z.ZodMiniObject<{
+  title: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+/** REST contract of the `/api/analytics` routes. */
+export declare const analyticsContract: RouteGroup<"/api/analytics", {
+  readonly ingestAnalyticsEvents: RouteDefinition<"POST", "/events", {
+    /** Sent as `text/plain` JSON by `navigator.sendBeacon`. */
+    readonly body: z.ZodMiniObject<{
+      token: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      clientId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      sessionId: z.ZodMiniString<string>;
+      sdkVersion: z.ZodMiniString<string>;
+      events: z.ZodMiniArray<z.ZodMiniObject<{
+        type: z.ZodMiniEnum<{
+          content_exposure: "content_exposure";
+          conversion: "conversion";
+          page_view: "page_view";
+        }>;
+        t: z.ZodMiniNumber<number>;
+        locale: z.ZodMiniString<string>;
+        url: z.ZodMiniString<string>;
+        ref: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        dictionaryKey: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        keyPath: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        nodeType: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        variant: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        count: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+        experimentKey: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        goal: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        value: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+      }, z.core.$loose>>;
+    }, z.core.$loose>;
+    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<{
+          accepted: z.ZodMiniNumber<number>;
+        }, 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 getAnalyticsOverview: RouteDefinition<"GET", "/overview", {
+    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<{
+          url: z.ZodMiniString<string>;
+          locale: z.ZodMiniString<string>;
+          views: z.ZodMiniNumber<number>;
+        }, 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 getAnalyticsAudience: RouteDefinition<"GET", "/audience", {
+    readonly querystring: z.ZodMiniObject<{
+      range: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      days: 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.ZodMiniObject<{
+          usersToday: z.ZodMiniNumber<number>;
+          usersLast7Days: z.ZodMiniNumber<number>;
+          usersInRange: z.ZodMiniNumber<number>;
+          viewsInRange: z.ZodMiniNumber<number>;
+          range: z.ZodMiniEnum<{
+            "1h": "1h";
+            "1y": "1y";
+            "24h": "24h";
+            "30d": "30d";
+            "3y": "3y";
+            "6mo": "6mo";
+            "7d": "7d";
+            "90d": "90d";
+          }>;
+          rangeHours: z.ZodMiniNumber<number>;
+          granularity: z.ZodMiniEnum<{
+            day: "day";
+            hour: "hour";
+            minute: "minute";
+            month: "month";
+            week: "week";
+          }>;
+          series: z.ZodMiniArray<z.ZodMiniObject<{
+            bucket: z.ZodMiniString<string>;
+            users: z.ZodMiniNumber<number>;
+            views: z.ZodMiniNumber<number>;
+          }, z.core.$strip>>;
+          byLocale: z.ZodMiniArray<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            users: z.ZodMiniNumber<number>;
+            views: z.ZodMiniNumber<number>;
+          }, z.core.$strip>>;
+          byCountry: z.ZodMiniArray<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            users: z.ZodMiniNumber<number>;
+            views: z.ZodMiniNumber<number>;
+          }, z.core.$strip>>;
+          byPage: z.ZodMiniArray<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            users: z.ZodMiniNumber<number>;
+            views: z.ZodMiniNumber<number>;
+          }, z.core.$strip>>;
+        }, 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 getContentStats: RouteDefinition<"GET", "/content-stats", {
+    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<{
+          dictionaryKey: z.ZodMiniString<string>;
+          keyPath: z.ZodMiniString<string>;
+          locale: z.ZodMiniString<string>;
+          exposures: z.ZodMiniNumber<number>;
+        }, 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 getExperimentResults: RouteDefinition<"GET", "/experiments/:experimentKey", {
+    readonly params: z.ZodMiniObject<{
+      experimentKey: 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<{
+          experimentKey: z.ZodMiniString<string>;
+          variants: z.ZodMiniArray<z.ZodMiniObject<{
+            variant: z.ZodMiniString<string>;
+            exposures: z.ZodMiniNumber<number>;
+            conversions: z.ZodMiniNumber<number>;
+            conversionRate: z.ZodMiniNumber<number>;
+          }, z.core.$strip>>;
+          pValue: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+          winner: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        }, 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 getPageMetadata: RouteDefinition<"GET", "/page-metadata", {
+    readonly querystring: z.ZodMiniObject<{
+      url: 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.ZodMiniObject<{
+          title: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        }, 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>;
+    };
+  }>;
+}>;
+/** Route definitions of the `/api/analytics` group, by name. */
+export type AnalyticsRoutes = (typeof analyticsContract)['routes'];
+export type AnalyticsEventType = z.output<typeof analyticsEventTypeSchema>;
+export type IncomingAnalyticsEvent = z.output<typeof incomingAnalyticsEventSchema>;
+export type AudienceRange = z.output<typeof audienceRangeSchema>;
+export type AudienceGranularity = z.output<typeof audienceGranularitySchema>;
+export type AudienceSeriesPoint = z.output<typeof audienceSeriesPointSchema>;
+export type AudienceBreakdownRow = z.output<typeof audienceBreakdownRowSchema>;
+export type AudienceStats = z.output<typeof audienceStatsSchema>;
+export type AnalyticsOverviewRow = z.output<typeof analyticsOverviewRowSchema>;
+export type ContentStatRow = z.output<typeof contentStatRowSchema>;
+export type ExperimentResult = z.output<typeof experimentResultSchema>;
+export type PageMetadata = z.output<typeof pageMetadataSchema>;
+export type IngestAnalyticsBody = RouteBodyInput<AnalyticsRoutes['ingestAnalyticsEvents']>;
+export type IngestAnalyticsResult = ResponseData<{
+  accepted: number;
+}>;
+export type GetAnalyticsOverviewResult = ResponseData<AnalyticsOverviewRow[]>;
+export type GetContentStatsResult = ResponseData<ContentStatRow[]>;
+export type GetExperimentResultsResult = ResponseData<ExperimentResult>;
+export type GetAudienceResult = ResponseData<AudienceStats>;
+export type GetPageMetadataResult = ResponseData<PageMetadata>;
+//#endregion
+//# sourceMappingURL=analytics.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","names":[],"sources":["../../src/analytics.ts"],"mappings":";;;;;qBASa,0BAAwB,EAAA;;;;;;qBAOxB,8BAA4B,EAAA;;;;;;;;;;;;;;;;;;GAevC,EAAA,KAAA;;qBAGW,qBAAmB,EAAA;;;;;;;;;;qBAWnB,2BAAyB,EAAA;;;;;;;qBAQzB,2BAAyB,EAAA;;;;GAKpC,EAAA,KAAA;cAEI,4BAA0B,EAAA;;;;GAI9B,EAAA,KAAA;qBAEW,qBAAmB,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAY9B,EAAA,KAAA;cAEI,4BAA0B,EAAA;;;;GAI9B,EAAA,KAAA;cAEI,sBAAoB,EAAA;;;;;GAKxB,EAAA,KAAA;cAEI,wBAAsB,EAAA;;;;;;;;;;GAY1B,EAAA,KAAA;cAEI,oBAAkB,EAAA;;;GAGtB,EAAA,KAAA;;qBAGW;kCAoBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;iCAUA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;iCAcU;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;iCASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;YAOX,0BAA0B;YAE1B,qBAAqB,EAAE,cAAc;YACrC,yBAAyB,EAAE,cAC9B;YAEG,gBAAgB,EAAE,cAAc;YAChC,sBAAsB,EAAE,cAAc;YACtC,sBAAsB,EAAE,cAAc;YACtC,uBAAuB,EAAE,cAAc;YACvC,gBAAgB,EAAE,cAAc;YAChC,uBAAuB,EAAE,cAAc;YACvC,iBAAiB,EAAE,cAAc;YACjC,mBAAmB,EAAE,cAAc;YACnC,eAAe,EAAE,cAAc;YAE/B,sBAAsB,eAChC;YAEU,wBAAwB;EAAe;;YACvC,6BAA6B,aAAa;YAC1C,wBAAwB,aAAa;YACrC,6BAA6B,aAAa;YAC1C,oBAAoB,aAAa;YACjC,wBAAwB,aAAa"}

package/dist/types/asset.d.ts

@@ -0,0 +1,207 @@
+import { RouteBodyInput, RouteDefinition, RouteGroup } from "./defineRoute.js";
+import { PaginatedResponse, ResponseData } from "./responseData.js";
+import { z } from "zod/mini";
+//#region src/asset.d.ts
+/** Image uploaded to a project (served from the CDN). */
+export declare const assetSchema: z.ZodMiniObject<{
+  id: z.ZodMiniString<string>;
+  projectId: z.ZodMiniString<string>;
+  originalName: z.ZodMiniString<string>;
+  mimeType: z.ZodMiniString<string>;
+  size: z.ZodMiniNumber<number>;
+  s3Key: z.ZodMiniString<string>;
+  publicUrl: z.ZodMiniString<string>;
+  alt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  caption: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  uploadedBy: z.ZodMiniString<string>;
+  createdAt: z.ZodMiniString<string>;
+  updatedAt: z.ZodMiniString<string>;
+}, z.core.$loose>;
+/** REST contract of the `/api/assets` routes (scoped to the selected project). */
+export declare const assetContract: RouteGroup<"/api/assets", {
+  readonly getAssets: 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>]>>;
+    }, 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<{
+          id: z.ZodMiniString<string>;
+          projectId: z.ZodMiniString<string>;
+          originalName: z.ZodMiniString<string>;
+          mimeType: z.ZodMiniString<string>;
+          size: z.ZodMiniNumber<number>;
+          s3Key: z.ZodMiniString<string>;
+          publicUrl: z.ZodMiniString<string>;
+          alt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          caption: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          uploadedBy: z.ZodMiniString<string>;
+          createdAt: z.ZodMiniString<string>;
+          updatedAt: z.ZodMiniString<string>;
+        }, 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 getAssetById: RouteDefinition<"GET", "/:assetId", {
+    readonly params: z.ZodMiniObject<{
+      assetId: 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<{
+          id: z.ZodMiniString<string>;
+          projectId: z.ZodMiniString<string>;
+          originalName: z.ZodMiniString<string>;
+          mimeType: z.ZodMiniString<string>;
+          size: z.ZodMiniNumber<number>;
+          s3Key: z.ZodMiniString<string>;
+          publicUrl: z.ZodMiniString<string>;
+          alt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          caption: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          uploadedBy: z.ZodMiniString<string>;
+          createdAt: z.ZodMiniString<string>;
+          updatedAt: z.ZodMiniString<string>;
+        }, 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 uploadAsset: RouteDefinition<"POST", "/", {
+    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<{
+          id: z.ZodMiniString<string>;
+          projectId: z.ZodMiniString<string>;
+          originalName: z.ZodMiniString<string>;
+          mimeType: z.ZodMiniString<string>;
+          size: z.ZodMiniNumber<number>;
+          s3Key: z.ZodMiniString<string>;
+          publicUrl: z.ZodMiniString<string>;
+          alt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          caption: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          uploadedBy: z.ZodMiniString<string>;
+          createdAt: z.ZodMiniString<string>;
+          updatedAt: z.ZodMiniString<string>;
+        }, 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 updateAsset: RouteDefinition<"PATCH", "/:assetId", {
+    readonly params: z.ZodMiniObject<{
+      assetId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly body: z.ZodMiniObject<{
+      originalName: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      alt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      caption: 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.ZodMiniObject<{
+          id: z.ZodMiniString<string>;
+          projectId: z.ZodMiniString<string>;
+          originalName: z.ZodMiniString<string>;
+          mimeType: z.ZodMiniString<string>;
+          size: z.ZodMiniNumber<number>;
+          s3Key: z.ZodMiniString<string>;
+          publicUrl: z.ZodMiniString<string>;
+          alt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          caption: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          uploadedBy: z.ZodMiniString<string>;
+          createdAt: z.ZodMiniString<string>;
+          updatedAt: z.ZodMiniString<string>;
+        }, 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 deleteAsset: RouteDefinition<"DELETE", "/:assetId", {
+    readonly params: z.ZodMiniObject<{
+      assetId: 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.ZodMiniNull>;
+        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/assets` group, by name. */
+export type AssetRoutes = (typeof assetContract)['routes'];
+export type AssetAPI = z.output<typeof assetSchema>;
+export type GetAssetsResult = PaginatedResponse<AssetAPI>;
+export type GetAssetByIdResult = ResponseData<AssetAPI>;
+export type UploadAssetResult = ResponseData<AssetAPI>;
+export type UpdateAssetBody = RouteBodyInput<AssetRoutes['updateAsset']>;
+export type UpdateAssetResult = ResponseData<AssetAPI>;
+export type DeleteAssetResult = ResponseData<null>;
+//#endregion
+//# sourceMappingURL=asset.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"asset.d.ts","names":[],"sources":["../../src/asset.ts"],"mappings":";;;;;qBAea,aAAW,EAAA;;;;;;;;;;;;;GAkBtB,EAAA,KAAA;;qBAMW;sBAUU;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAcA;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;YAOX,sBAAsB;YAEtB,WAAW,EAAE,cAAc;YAC3B,kBAAkB,kBAAkB;YACpC,qBAAqB,aAAa;YAClC,oBAAoB,aAAa;YACjC,kBAAkB,eAAe;YACjC,oBAAoB,aAAa;YACjC,oBAAoB"}