@powersync/management-types 0.0.0-dev.85b697f3

package/dist/routes/general-routes.d.ts

@@ -0,0 +1,78 @@
+import 'bson';
+import * as t from 'ts-codec';
+export * from './schema.js';
+export declare enum GENERAL_ROUTES {
+    /** GET */
+    LIST_REGIONS = "/api/v1/regions",
+    /**
+     * @deprecated use LIST_VERSIONS_V2 instead
+     */
+    LIST_VERSIONS = "/api/v1/channel-versions",
+    LIST_VERSIONS_V2 = "/api/v2/channel-versions"
+}
+export declare const ListRegionsRequest: t.ObjectCodec<{}>;
+export type ListRegionsRequest = t.Encoded<typeof ListRegionsRequest>;
+/**
+ * For IP whitelisting, we recommend just including IPs from all regions.
+ *
+ * An additional "dev" region is included, with IPs  used for development purposes,
+ * e.g. "test connection".
+ */
+export declare const ListRegionsResponse: t.ObjectCodec<{
+    regions: t.ArrayCodec<t.ObjectCodec<{
+        name: t.IdentityCodec<t.CodecType.String>;
+        /** false for "dev" region */
+        deployable: t.IdentityCodec<t.CodecType.Boolean>;
+        ips: t.ArrayCodec<t.IdentityCodec<t.CodecType.String>>;
+    }>>;
+}>;
+export type ListRegionsResponse = t.Encoded<typeof ListRegionsResponse>;
+/**
+* @deprecated
+*/
+export declare const ListVersionsRequest: t.Intersection<t.Codec<{
+    cursor?: string | undefined;
+    limit?: number | undefined;
+}, {
+    cursor?: string | undefined;
+    limit?: number | undefined;
+}, string, t.CodecProps>, t.ObjectCodec<{
+    channel: t.IdentityCodec<t.CodecType.String>;
+}>>;
+/**
+ * @deprecated
+ */
+export type ListVersionsRequest = t.Encoded<typeof ListVersionsRequest>;
+/**
+ * @deprecated
+ */
+export declare const ListVersionsResponse: t.ObjectCodec<{
+    total: t.IdentityCodec<t.CodecType.Number>;
+    count: t.IdentityCodec<t.CodecType.Number>;
+    more: t.IdentityCodec<t.CodecType.Boolean>;
+    cursor: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    items: t.ArrayCodec<t.IdentityCodec<t.CodecType.String>>;
+}>;
+/**
+ * @deprecated
+ */
+export type ListVersionsResponse = t.Encoded<typeof ListVersionsResponse>;
+export declare enum VersionStatus {
+    CURRENT = "current",
+    AVAILABLE = "available",
+    DEPRECATED = "deprecated"
+}
+export declare const Version: t.ObjectCodec<{
+    version: t.IdentityCodec<t.CodecType.String>;
+    status: t.EnumCodec<typeof VersionStatus>;
+}>;
+export type Version = t.Encoded<typeof Version>;
+export declare const ListVersionsRequestV2: t.ObjectCodec<{
+    channel: t.IdentityCodec<t.CodecType.String>;
+}>;
+export type ListVersionsRequestV2 = t.Encoded<typeof ListVersionsRequestV2>;
+export declare const ListVersionsResponseV2: t.ArrayCodec<t.ObjectCodec<{
+    version: t.IdentityCodec<t.CodecType.String>;
+    status: t.EnumCodec<typeof VersionStatus>;
+}>>;
+export type ListVersionsResponseV2 = t.Encoded<typeof ListVersionsResponseV2>;

package/dist/routes/general-routes.js

@@ -0,0 +1,57 @@
+// Required for the ObjectId codec
+import 'bson';
+import * as t from 'ts-codec';
+import { PaginationRequest, PaginationResponse } from '../utils/pagination.js';
+export * from './schema.js';
+export var GENERAL_ROUTES;
+(function (GENERAL_ROUTES) {
+    /** GET */
+    GENERAL_ROUTES["LIST_REGIONS"] = "/api/v1/regions";
+    /**
+     * @deprecated use LIST_VERSIONS_V2 instead
+     */
+    GENERAL_ROUTES["LIST_VERSIONS"] = "/api/v1/channel-versions";
+    GENERAL_ROUTES["LIST_VERSIONS_V2"] = "/api/v2/channel-versions";
+})(GENERAL_ROUTES || (GENERAL_ROUTES = {}));
+// GET /api/v1/regions
+// Returns list of regions to whitelist on the database.
+export const ListRegionsRequest = t.object({});
+/**
+ * For IP whitelisting, we recommend just including IPs from all regions.
+ *
+ * An additional "dev" region is included, with IPs  used for development purposes,
+ * e.g. "test connection".
+ */
+export const ListRegionsResponse = t.object({
+    regions: t.array(t.object({
+        name: t.string,
+        /** false for "dev" region */
+        deployable: t.boolean,
+        ips: t.array(t.string)
+    }))
+});
+/**
+* @deprecated
+*/
+export const ListVersionsRequest = PaginationRequest.and(t.object({
+    channel: t.string
+}));
+/**
+ * @deprecated
+ */
+export const ListVersionsResponse = PaginationResponse(t.string);
+export var VersionStatus;
+(function (VersionStatus) {
+    VersionStatus["CURRENT"] = "current";
+    VersionStatus["AVAILABLE"] = "available";
+    VersionStatus["DEPRECATED"] = "deprecated";
+})(VersionStatus || (VersionStatus = {}));
+export const Version = t.object({
+    version: t.string,
+    status: t.Enum(VersionStatus)
+});
+export const ListVersionsRequestV2 = t.object({
+    channel: t.string
+});
+export const ListVersionsResponseV2 = t.array(Version);
+//# sourceMappingURL=general-routes.js.map

package/dist/routes/general-routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"general-routes.js","sourceRoot":"","sources":["../../src/routes/general-routes.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,OAAO,MAAM,CAAC;AACd,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE/E,cAAc,aAAa,CAAC;AAE5B,MAAM,CAAN,IAAY,cAQT;AARH,WAAY,cAAc;IACtB,UAAU;IACV,kDAAgC,CAAA;IAChC;;OAEG;IACH,4DAA0C,CAAA;IAC1C,+DAA6C,CAAA;AAC/C,CAAC,EARS,cAAc,KAAd,cAAc,QAQvB;AAEH,sBAAsB;AACtB,wDAAwD;AACxD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAG/C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,MAAM;QACd,6BAA6B;QAC7B,UAAU,EAAE,CAAC,CAAC,OAAO;QACrB,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;KACvB,CAAC,CACH;CACF,CAAC,CAAC;AAGD;;EAEC;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,GAAG,CACpD,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,CAAC,CAAC,MAAM;CAClB,CAAC,CACH,CAAC;AAMF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAMjE,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,wCAAuB,CAAA;IACvB,0CAAyB,CAAA;AAC3B,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAED,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM;IACjB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,OAAO,EAAE,CAAC,CAAC,MAAM;CAClB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC"}

package/dist/routes/index.d.ts

@@ -0,0 +1,6 @@
+export * from './dashboard-routes.js';
+export * from './dev-routes.js';
+export * from './general-routes.js';
+export * from './manage-routes.js';
+export * from './reporting-routes.js';
+export * from './schema.js';

package/dist/routes/index.js

@@ -0,0 +1,7 @@
+export * from './dashboard-routes.js';
+export * from './dev-routes.js';
+export * from './general-routes.js';
+export * from './manage-routes.js';
+export * from './reporting-routes.js';
+export * from './schema.js';
+//# sourceMappingURL=index.js.map

package/dist/routes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/routes/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC"}