@intlayer/backend-contract 0.0.0-stage → 9.6.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"project.d.ts","names":[],"sources":["../../src/project.ts"],"mappings":";;;;;;;qBA2Ba,cAAY,EAAA,cAAA,QAAA;;YAGb,kBAAkB,QAAQ;;EAEpC;EACA;;;;;;qBAOW,4BAA0B,EAAA;;;;;;;;;;GAcrC,EAAA,KAAA;;qBAGW,eAAa,EAAA;;;;;;GAOxB,EAAA,KAAA;;qBAGW,iBAAe,EAAA;;;;;;;;;;GAK1B,EAAA,KAAA;;qBAGW,0BAAwB,EAAA;;;;;;;;;;;qBAoBxB,4BAA0B,EAAA,2BAAA,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoBrC,EAAA,KAAA;;qBAQW,mBAAiB,EAAA;;;;;;;;;;;;;;;;;GAO5B,EAAA,KAAA;;qBAGW,mCAAiC,EAAA;;;;GAI5C,EAAA,KAAA;;qBAGW,iBAAe,EAAA;;;;;;;;;;;;GAa1B,EAAA,KAAA;;qBAGW,eAAa,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmBxB,EAAA,KAAA;;qBAGW,qBAAmB,EAAA;;;;;;;GAQ9B,EAAA,KAAA;;qBAGW,uBAAqB,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BhC,EAAA,KAAA;;qBAGW,gBAAc,EAAA;;;;;;GAMzB,EAAA,KAAA;cAKI,sBAAoB,EAAA;;;;GAIxB,EAAA,KAAA;;qBAGW;wBAqBU;;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAsBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAkBA;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCASA;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;4BAqBA;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;yBASV;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;2BAYU;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;+BAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;gCASV;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;mCAUU;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAcV;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;YAQD,wBAAwB;YAGxB,uBAAuB,EAAE,cAAc;YACvC,UAAU,EAAE,cAAc;YAC1B,kBAAkB,EAAE,cAAc;YAClC,qBAAqB,EAAE,cAAc;YACrC,uBAAuB,EAAE,cAAc;YACvC,iBAAiB,EAAE,cAAc;YACjC,iCAAiC,EAAE,cACtC;YAEG,kBAAkB,EAAE,cAAc;YAClC,aAAa,EAAE,cAAc;YAC7B,kBAAkB,EAAE,cAAc;YAClC,WAAW,EAAE,cAAc;YAG3B,oBAAoB,iBAAiB;YACrC,oBAAoB,kBAAkB;YACtC,2BAA2B,aAAa;YACxC,iBAAiB,eAAe;YAChC,mBAAmB,aAAa;YAChC,oBAAoB,eAAe;YACnC,sBAAsB,aAAa;YACnC,2BAA2B,eACrC;YAEU,6BAA6B,aAAa;YAC1C,+BAA+B,eACzC;YAEU,iCAAiC,aAAa;YAC9C,sBAAsB,aAAa;YACnC,qBAAqB,YAAY;YACjC,sBAAsB,aAAa;YACnC,wBAAwB;;YAExB,sBAAsB,KAChC,eAAe;EAEX,YAAY;;YACN,0BAA0B,aAAa;YACvC,uBAAuB,UAAU;YACjC,2BAA2B,aAAa;YACxC,sBAAsB,UAAU;YAChC,0BAA0B;YAC1B,qBAAqB;EAC/B,SAAS,EAAE,cAAc;;YAEf,qBAAqB,UAAU;YAC/B,uBAAuB,aACjC,EAAE,cAAc;YAEN,2BAA2B,aAAa;YACxC,4BAA4B;EAAe;;YAC3C,+BAA+B,aAAa;YAC5C,2BAA2B,YACrC;YAEU,yBAAyB,eACnC;YAEU,2BACV,aAAa"}

package/dist/types/public.d.ts

@@ -0,0 +1,109 @@
+import { RouteBodyInput, RouteDefinition, RouteGroup } from "./defineRoute.js";
+import { ResponseData } from "./responseData.js";
+import { DictionaryAPI } from "./dictionary.js";
+import { z } from "zod/mini";
+//#region src/public.d.ts
+/** Capabilities a public browser token may carry (deliberately narrow). */
+export declare const publicBrowserScopeSchema: z.ZodMiniEnum<{
+  "analytics:ingest": "analytics:ingest";
+  "dictionary:read": "dictionary:read";
+}>;
+declare const publicBrowserTokenSchema: z.ZodMiniObject<{
+  token: z.ZodMiniNullable<z.ZodMiniString<string>>;
+  scopes: z.ZodMiniArray<z.ZodMiniEnum<{
+    "analytics:ingest": "analytics:ingest";
+    "dictionary:read": "dictionary:read";
+  }>>;
+  expiresIn: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+/**
+ * REST contract of the credential-free routes a browser SDK reaches on its
+ * own (rate limited per IP).
+ */
+export declare const publicContract: RouteGroup<"/api/public", {
+  readonly createPublicBrowserToken: RouteDefinition<"POST", "/token", {
+    readonly body: z.ZodMiniOptional<z.ZodMiniObject<{
+      clientId: 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<{
+          token: z.ZodMiniNullable<z.ZodMiniString<string>>;
+          scopes: z.ZodMiniArray<z.ZodMiniEnum<{
+            "analytics:ingest": "analytics:ingest";
+            "dictionary:read": "dictionary:read";
+          }>>;
+          expiresIn: 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 getPublicDictionaryKeys: RouteDefinition<"GET", "/dictionaries/keys", {
+    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.ZodMiniString<string>>>;
+        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 getPublicDictionaries: RouteDefinition<"GET", "/dictionaries", {
+    readonly querystring: z.ZodMiniObject<{
+      keys: 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.ZodMiniCustom<DictionaryAPI, DictionaryAPI>>>;
+        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 public group, by name. */
+export type PublicRoutes = (typeof publicContract)['routes'];
+export type PublicBrowserScope = z.output<typeof publicBrowserScopeSchema>;
+export type CreatePublicBrowserTokenBody = NonNullable<RouteBodyInput<PublicRoutes['createPublicBrowserToken']>>;
+export type CreatePublicBrowserTokenResult = ResponseData<z.output<typeof publicBrowserTokenSchema>>;
+export type GetPublicDictionariesQuery = {
+  keys?: string;
+};
+export type GetPublicDictionariesResult = ResponseData<DictionaryAPI[]>;
+export type GetPublicDictionaryKeysResult = ResponseData<string[]>;
+//#endregion
+//# sourceMappingURL=public.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"public.d.ts","names":[],"sources":["../../src/public.ts"],"mappings":";;;;;;qBAUa,0BAAwB,EAAA;;;;cAO/B,0BAAwB,EAAA;;;;;;;GAO5B,EAAA,KAAA;;;;;qBAMW;qCAeU;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;oCAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;kCAYA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;YAOX,uBAAuB;YAEvB,qBAAqB,EAAE,cAAc;YACrC,+BAA+B,YACzC,eAAe;YAEL,iCAAiC,aAC3C,EAAE,cAAc;YAEN;EAA+B;;YAC/B,8BAA8B,aAAa;YAC3C,gCAAgC"}

package/dist/types/responseData.d.ts

@@ -0,0 +1,68 @@
+import { $ZodType } from "zod/v4/core";
+import { z } from "zod/mini";
+//#region src/responseData.d.ts
+/** Error payload attached to failed responses. */
+export declare const errorDataSchema: z.ZodMiniObject<{
+  code: z.ZodMiniString<string>;
+  title: z.ZodMiniString<string>;
+  message: z.ZodMiniString<string>;
+}, z.core.$loose>;
+/** Wraps a data schema in the backend `ResponseData<T>` envelope. */
+export declare const responseDataSchema: <DataSchema extends $ZodType>(data: DataSchema) => 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<DataSchema>;
+  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>;
+/** Wraps an item schema in the backend `PaginatedResponse<T>` envelope. */
+export declare const paginatedResponseSchema: <ItemSchema extends $ZodType>(item: ItemSchema) => 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<ItemSchema>>;
+  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>;
+/** Error payload attached to failed responses. */
+export type ErrorData = z.output<typeof errorDataSchema>;
+/** Envelope of every backend response. */
+export type ResponseData<Data = null> = {
+  message?: string;
+  description?: string;
+  success: boolean;
+  status: number;
+  data: Data | null;
+  error?: ErrorData | ErrorData[];
+};
+/** Envelope of paginated list responses. */
+export type PaginatedResponse<Item = undefined> = Omit<ResponseData<Item>, 'data'> & {
+  data: Item[] | null;
+  page: number | null;
+  page_size: number | null;
+  total_pages: number | null;
+  total_items: number | null;
+};
+//#endregion
+//# sourceMappingURL=responseData.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"responseData.d.ts","names":[],"sources":["../../src/responseData.ts"],"mappings":";;;;qBAIa,iBAAe,EAAA;;;;GAI1B,EAAA,KAAA;;qBAGW,qBAAsB,mBAAmB,UAAQ,MACtD,eAAU,EAAA;;;;;;;;;;;;;;;GASd,EAAA,KAAA;;qBAGS,0BAA2B,mBAAmB,UAAQ,MAC3D,eAAU,EAAA;;;;;;;;;;;;;;;;;;;GAQd,EAAA,KAAA;;YAGQ,YAAY,EAAE,cAAc;;YAG5B,aAAa;EACvB;EACA;EACA;EACA;EACA,MAAM;EACN,QAAQ,YAAY;;;YAIV,kBAAkB,oBAAoB,KAChD,aAAa;EAGb,MAAM;EACN;EACA;EACA;EACA"}