@conduitplatform/grpc-sdk 0.16.26 → 0.17.0-alpha.1

package/dist/module.proto

@@ -9,8 +9,33 @@ message SetConfigResponse {
   string updatedConfig = 1;
 }
 
+message GetExportableResourcesRequest {}
+
+message GetExportableResourcesResponse {
+  string resources = 1;
+}
+
+message ExportResourcesRequest {
+  repeated string resourceTypes = 1;
+}
+
+message ExportResourcesResponse {
+  string data = 1;
+}
+
+message ImportResourcesRequest {
+  string data = 1;
+}
+
+message ImportResourcesResponse {
+  string result = 1;
+}
+
 service ConduitModule {
   rpc SetConfig(SetConfigRequest) returns (SetConfigResponse);
+  rpc GetExportableResources(GetExportableResourcesRequest) returns (GetExportableResourcesResponse);
+  rpc ExportResources(ExportResourcesRequest) returns (ExportResourcesResponse);
+  rpc ImportResources(ImportResourcesRequest) returns (ImportResourcesResponse);
 }
 
 service ClientRouter {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@conduitplatform/grpc-sdk",
-  "version": "0.16.26",
+  "version": "0.17.0-alpha.1",
   "main": "dist/index.cjs",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -18,35 +18,29 @@
     }
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=20"
   },
   "type": "module",
-  "scripts": {
-    "prepublish": "npm run build",
-    "prebuild": "npm run protoc",
-    "build": "rimraf dist && rollup -c",
-    "postbuild": "copyfiles -u 1 src/*.proto src/**/*.json ./dist/",
-    "protoc": "sh build.sh"
-  },
   "license": "MIT",
   "dependencies": {
-    "@grpc/grpc-js": "^1.13.3",
-    "@grpc/proto-loader": "^0.7.13",
+    "@bufbuild/protobuf": "^2.10.2",
+    "@grpc/grpc-js": "^1.14.3",
+    "@grpc/proto-loader": "^0.8.0",
     "@sesamecare-oss/redlock": "^1.2.0",
-    "abort-controller-x": "^0.4.3",
-    "convict": "^6.2.4",
-    "express": "^4.22.0",
-    "fast-jwt": "^6.0.2",
-    "fs-extra": "^11.2.0",
-    "ioredis": "^5.3.2",
-    "lodash": "^4.17.21",
-    "lodash-es": "^4.17.21",
-    "nice-grpc": "^2.1.12",
-    "nice-grpc-client-middleware-retry": "^3",
+    "abort-controller-x": "^0.5.0",
+    "convict": "^6.2.5",
+    "express": "^5.2.1",
+    "fast-jwt": "^6.1.0",
+    "fs-extra": "^11.3.4",
+    "ioredis": "^5.10.1",
+    "lodash": "^4.18.1",
+    "lodash-es": "^4.18.1",
+    "nice-grpc": "^2.1.14",
+    "nice-grpc-client-middleware-retry": "^3.1.13",
     "prom-client": "^15.1.3",
-    "protobufjs": "^7.2.6",
-    "winston": "^3.12.0",
-    "winston-loki": "^6.0.8"
+    "protobufjs": "^8.0.1",
+    "winston": "^3.19.0",
+    "winston-loki": "^6.1.4"
   },
   "directories": {
     "lib": "dist",
@@ -61,26 +55,28 @@
     "directory": "libraries/grpc-sdk"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^26.0.1",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-replace": "^5.0.7",
-    "@rollup/plugin-typescript": "^11.1.6",
     "@types/convict": "^6.1.6",
-    "@types/express": "^4.17.21",
+    "@types/express": "^5.0.6",
     "@types/fs-extra": "^11.0.4",
     "@types/google-protobuf": "^3.15.12",
-    "@types/lodash": "^4.17.12",
+    "@types/lodash": "^4.17.24",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "20.11.24",
+    "@types/node": "24.9.1",
     "copyfiles": "^2.4.1",
-    "rimraf": "^5.0.5",
-    "rollup": "^4.22.4",
+    "rimraf": "^6.1.3",
     "ts-node": "^10.9.2",
-    "ts-proto": "^1.167.1",
+    "ts-proto": "^2.11.6",
     "tslib": "^2.6.3",
-    "typescript": "~5.6.2"
+    "tsup": "^8.5.1",
+    "typescript": "~6.0.2"
   },
   "peerDependencies": {
     "@grpc/grpc-js": "^1.13.3"
+  },
+  "scripts": {
+    "prepublish": "npm run build",
+    "prebuild": "npm run protoc",
+    "build": "rimraf dist && tsup",
+    "protoc": "sh build.sh"
   }
-}
+}

package/dist/classes/ConduitAuthorizedResource.d.ts

@@ -1,12 +0,0 @@
-import { Resource_Permission, Resource_Relation } from '../protoUtils/index.js';
-export declare class ConduitAuthorizedResource {
-    readonly name: string;
-    readonly relations: Resource_Relation[];
-    readonly permissions: Resource_Permission[];
-    readonly version?: number;
-    constructor(name: string, relations: {
-        [field: string]: string | string[];
-    }, permissions: {
-        [action: string]: string | string[];
-    }, version?: number);
-}

package/dist/classes/ConduitModule.d.ts

@@ -1,28 +0,0 @@
-import { CompatServiceDefinition } from 'nice-grpc/lib/service-definitions';
-import { Channel, Client } from 'nice-grpc';
-import { ConduitModuleDefinition, HealthDefinition } from '../protoUtils/index.js';
-import { EventEmitter } from 'events';
-export declare class ConduitModule<T extends CompatServiceDefinition> {
-    readonly _clientName: string;
-    private readonly _serviceName;
-    private readonly _serviceUrl;
-    private readonly _grpcToken?;
-    protected channel?: Channel;
-    protected protoPath?: string;
-    protected type?: T;
-    protected readonly healthCheckEmitter: EventEmitter<[never]>;
-    constructor(_clientName: string, _serviceName: string, _serviceUrl: string, _grpcToken?: string | undefined);
-    private _client?;
-    get client(): Client<T> | undefined;
-    private _healthClient?;
-    get healthClient(): Client<typeof HealthDefinition> | undefined;
-    private _moduleClient?;
-    get moduleClient(): Client<typeof ConduitModuleDefinition> | undefined;
-    get active(): boolean;
-    get healthCheckWatcher(): EventEmitter<[never]>;
-    initializeClient(type: T): Client<T>;
-    openConnection(): void;
-    closeConnection(): void;
-    check(service?: string): Promise<import("../index.js").HealthCheckResponse_ServingStatus>;
-    watch(service?: string): Promise<void>;
-}

package/dist/classes/ConduitSchema.d.ts

@@ -1,10 +0,0 @@
-import { ConduitModel, ConduitSchemaOptions } from '../interfaces/index.js';
-export declare class ConduitSchema {
-    readonly name: string;
-    readonly fields: ConduitModel;
-    readonly collectionName: string | '';
-    readonly modelOptions: ConduitSchemaOptions;
-    ownerModule: string;
-    parentSchema?: string;
-    constructor(name: string, fields: ConduitModel, modelOptions?: ConduitSchemaOptions, collectionName?: string);
-}

package/dist/classes/Error.d.ts

@@ -1,11 +0,0 @@
-export declare class ConduitError extends Error {
-    message: string;
-    name: string;
-    status: number;
-    constructor(name: string, status: number, message: string);
-    static unauthorized(message?: string): ConduitError;
-    static notFound(message?: string): ConduitError;
-    static forbidden(message?: string): ConduitError;
-    static userInput(message?: string): ConduitError;
-    static internalServerError(message?: string): void;
-}

package/dist/classes/HealthCheck.d.ts

@@ -1 +0,0 @@
-export declare function checkModuleHealth(clientName: string, serviceUrl: string, service?: string, grpcToken?: string): Promise<any>;

package/dist/classes/index.d.ts

@@ -1,5 +0,0 @@
-export * from './Error.js';
-export * from './ConduitModule.js';
-export * from './HealthCheck.js';
-export * from './ConduitSchema.js';
-export * from './ConduitAuthorizedResource.js';

package/dist/constants/enums/PlatformTypesEnum.d.ts

@@ -1,10 +0,0 @@
-export declare enum PlatformTypesEnum {
-    WEB = "WEB",
-    ANDROID = "ANDROID",
-    IOS = "IOS",
-    IPADOS = "IPADOS",
-    WINDOWS = "WINDOWS",
-    MACOS = "MACOS",
-    LINUX = "LINUX",
-    CLI = "CLI"
-}

package/dist/constants/enums/index.d.ts

@@ -1 +0,0 @@
-export * from './PlatformTypesEnum.js';

package/dist/constants/index.d.ts

@@ -1 +0,0 @@
-export * from './enums/index.js';

package/dist/interceptors/grpcSignedToken.d.ts

@@ -1,2 +0,0 @@
-import { CallOptions, ClientMiddlewareCall } from 'nice-grpc';
-export declare function getGrpcSignedTokenInterceptor(grpcToken: string): <Request, Response>(call: ClientMiddlewareCall<Request, Response>, options: CallOptions) => AsyncGenerator<Awaited<Response>, void | Awaited<Response>, undefined>;

package/dist/interceptors/index.d.ts

@@ -1,2 +0,0 @@
-export * from './moduleName.js';
-export * from './grpcSignedToken.js';

package/dist/interceptors/moduleName.d.ts

@@ -1,2 +0,0 @@
-import { CallOptions, ClientMiddlewareCall } from 'nice-grpc';
-export declare function getModuleNameInterceptor(moduleName: string): <Request, Response>(call: ClientMiddlewareCall<Request, Response>, options: CallOptions) => AsyncGenerator<Awaited<Response>, void | Awaited<Response>, undefined>;

package/dist/interfaces/ConduitMiddleware.d.ts

@@ -1,7 +0,0 @@
-import { ConduitRouteActions } from './Route.js';
-export interface ConduitMiddlewareOptions {
-    action?: ConduitRouteActions;
-    path?: string;
-    name: string;
-    description?: string;
-}

package/dist/interfaces/ConduitRoute.d.ts

@@ -1,7 +0,0 @@
-import { ConduitRouteReturnDefinition } from './ConduitRouteReturn.js';
-import { ConduitRouteOptions } from './Route.js';
-export interface ConduitRoute {
-    returnType: ConduitRouteReturnDefinition;
-    input: ConduitRouteOptions;
-    handler: any;
-}

package/dist/interfaces/ConduitRouteReturn.d.ts

@@ -1,48 +0,0 @@
-import { ConduitReturn } from './Route.js';
-/**
- * Supports:
- * {
- *     name: 'String',
- *     age: 'Number
- *     ....
- * }
- *
- * or
- *
- * {
- *     name: {
- *         type: 'String',
- *         required: true
- *     },
- *     age: 'Number'
- * }
- *
- * or
- *
- * {
- *     user: {
- *         username: 'String',
- *         age: {
- *             type: 'Number',
- *             required: true
- *         }
- *     }
- * }
- *
- * or
- *
- * {
- *     user:{
- *         friends: ['String'],
- *         post: [{type: 'String', required:trues}]
- *     }
- * }
- *
- */
-export declare class ConduitRouteReturnDefinition {
-    private readonly _name;
-    private readonly _fields;
-    constructor(name: string, fields?: ConduitReturn);
-    get name(): string;
-    get fields(): ConduitReturn;
-}

package/dist/interfaces/ConduitSchemaExtension.d.ts

@@ -1,5 +0,0 @@
-import { ConduitModel } from './Model.js';
-export interface ConduitSchemaExtension {
-    readonly schemaName: string;
-    readonly fields: ConduitModel;
-}

package/dist/interfaces/GrpcCallback.d.ts

@@ -1,4 +0,0 @@
-export type GrpcCallback<ResponseType> = (error: {
-    code: number;
-    message: string;
-} | null, response?: ResponseType) => void;

package/dist/interfaces/IConduitLogger.d.ts

@@ -1,13 +0,0 @@
-import winston, { LogCallback, Logger } from 'winston';
-import { Indexable } from './Indexable.js';
-export interface IConduitLogger {
-    get winston(): winston.Logger;
-    log(message: string, level?: string, cb?: LogCallback): Logger;
-    logObject(object: Indexable, message?: string, level?: string, cb?: LogCallback): Logger;
-    info(message: string, cb?: LogCallback): Logger;
-    warn(message: string, cb?: LogCallback): Logger;
-    error(message: string | Error, cb?: LogCallback): Logger;
-    http(message: string, cb?: LogCallback): Logger;
-    verbose(message: string, cb?: LogCallback): Logger;
-    addTransport(transport: winston.transport): void;
-}

package/dist/interfaces/IConduitMetrics.d.ts

@@ -1,16 +0,0 @@
-import { Counter, CounterConfiguration, Gauge, GaugeConfiguration, Histogram, HistogramConfiguration, LabelValues, Metric, MetricConfiguration, Summary, SummaryConfiguration } from 'prom-client';
-import { MetricType } from '../types/index.js';
-export interface IConduitMetrics {
-    initializeDefaultMetrics(): void;
-    registerMetric(type: MetricType, config: MetricConfiguration<string>): void;
-    collectDefaultMetrics(): void;
-    createCounter(config: CounterConfiguration<any>): Counter<any>;
-    createSummary(config: SummaryConfiguration<any>): Summary<any>;
-    createHistogram(config: HistogramConfiguration<any>): Histogram<any>;
-    createGauge(config: GaugeConfiguration<any>): Gauge<any>;
-    getMetric(name: string): Metric<string> | undefined;
-    increment(metric: string, increment?: number, labels?: LabelValues<any>): void;
-    decrement(metric: string, decrement?: number, labels?: LabelValues<any>): void;
-    set(metric: string, value: number, labels?: LabelValues<any>): void;
-    observe(metric: string, value: number, labels?: LabelValues<any>): void;
-}

package/dist/interfaces/Indexable.d.ts

@@ -1,9 +0,0 @@
-export type Indexable = {
-    [key: string]: any;
-};
-export type Params = Indexable;
-export type Document = Indexable;
-export type Route = Indexable;
-export type Headers = Indexable;
-export type Context = Indexable;
-export type Cookies = Indexable;

package/dist/interfaces/Model.d.ts

@@ -1,170 +0,0 @@
-export declare enum TYPE {
-    String = "String",
-    Number = "Number",
-    Boolean = "Boolean",
-    Date = "Date",
-    ObjectId = "ObjectId",
-    JSON = "JSON",
-    Relation = "Relation"
-}
-export declare enum SQLDataType {
-    VARCHAR = "VARCHAR",
-    TEXT = "TEXT",
-    CHAR = "CHAR",
-    INT = "INT",
-    BIGINT = "BIGINT",
-    FLOAT = "FLOAT",
-    DOUBLE = "DOUBLE",
-    DECIMAL = "DECIMAL",
-    TIME = "TIME",
-    DATETIME = "DATETIME",
-    TIMESTAMP = "TIMESTAMP"
-}
-export declare enum MongoIndexType {
-    Ascending = 1,
-    Descending = -1,
-    GeoSpatial2d = "2d",
-    GeoSpatial2dSphere = "2dsphere",
-    GeoHaystack = "geoHaystack",
-    Hashed = "hashed",
-    Text = "text"
-}
-export declare enum PostgresIndexType {
-    BTREE = "BTREE",
-    HASH = "HASH",
-    GIST = "GIST",
-    SPGIST = "SPGIST",
-    GIN = "GIN",
-    BRIN = "BRIN"
-}
-export type Array = any[];
-type BaseConduitModelField = {
-    type?: TYPE | TYPE[] | ConduitModel | ArrayConduitModel[];
-    sqlType?: SQLDataType;
-    default?: any;
-    description?: string;
-    required?: boolean;
-    select?: boolean;
-};
-type UniqueAndRequiredField = {
-    unique: true;
-    required: true;
-    index?: SchemaFieldIndex;
-};
-type NotUniqueField = {
-    unique?: false;
-    required?: boolean;
-    index?: SchemaFieldIndex;
-};
-export type BasicConduitModelField = BaseConduitModelField & (UniqueAndRequiredField | NotUniqueField);
-export type ConduitModelFieldRelation = BasicConduitModelField & {
-    type: TYPE.Relation | TYPE.Relation[];
-    model: string;
-};
-export type ConduitModelFieldJSON = BasicConduitModelField & {
-    type: TYPE.JSON | TYPE.JSON[];
-};
-export type ConduitModelFieldEnum = BasicConduitModelField & {
-    type: ExcludeJSONRelation<TYPE> | ExcludeJSONRelation<TYPE>[];
-    enum: any;
-};
-export type ConduitModelField = BasicConduitModelField & {
-    type?: ExcludeJSONRelation<TYPE> | ExcludeJSONRelation<TYPE>[] | ConduitModel | ArrayConduitModel[];
-};
-export type allowedTypes = ExcludeRelation<TYPE> | ConduitModelField | ConduitModelFieldEnum | ConduitModelFieldJSON | ConduitModelFieldRelation;
-type embeddableArray = ExcludeRelation<TYPE> | ConduitModelField | ConduitModelFieldEnum | ConduitModelFieldJSON;
-type ExcludeRelation<T> = T extends TYPE.Relation ? never : T;
-type ExcludeJSON<T> = T extends TYPE.JSON ? never : T;
-type ExcludeJSONRelation<T> = ExcludeJSON<ExcludeRelation<T>>;
-export type ArrayConduitModel = {
-    type?: never;
-    sqlType?: never;
-    default?: never;
-    description?: never;
-    required?: never;
-    select?: never;
-    unique?: never;
-    index?: never;
-    enum?: never;
-    model?: never;
-} & {
-    [field in string]: embeddableArray | embeddableArray[];
-};
-export type ConduitModel = {
-    type?: never;
-    sqlType?: never;
-    default?: never;
-    description?: never;
-    required?: never;
-    select?: never;
-    unique?: never;
-    index?: never;
-    enum?: never;
-    model?: never;
-} & {
-    [field in string]: allowedTypes | allowedTypes[] | ConduitModel;
-};
-export declare const ConduitModelOptionsPermModifyType: string[];
-export interface ConduitSchemaOptions {
-    timestamps?: boolean;
-    _id?: boolean;
-    conduit?: {
-        [field: string]: any;
-        permissions?: {
-            extendable: boolean;
-            canCreate: boolean;
-            canModify: 'Everything' | 'Nothing' | 'ExtensionOnly';
-            canDelete: boolean;
-        };
-        authorization?: {
-            enabled: boolean;
-        };
-    };
-    indexes?: ModelOptionsIndexes[];
-}
-export interface SchemaFieldIndex {
-    type?: MongoIndexType | PostgresIndexType;
-    options?: MongoIndexOptions | PostgresIndexOptions;
-    [field: string]: any;
-}
-export interface ModelOptionsIndexes {
-    fields: string[];
-    types?: MongoIndexType[] | PostgresIndexType;
-    options?: MongoIndexOptions | PostgresIndexOptions;
-    [field: string]: any;
-}
-export interface MongoIndexOptions {
-    background?: boolean;
-    unique?: boolean;
-    name?: string;
-    partialFilterExpression?: Document;
-    sparse?: boolean;
-    expireAfterSeconds?: number;
-    storageEngine?: Document;
-    commitQuorum?: number | string;
-    version?: number;
-    weights?: Document;
-    default_language?: string;
-    language_override?: string;
-    textIndexVersion?: number;
-    '2dsphereIndexVersion'?: number;
-    bits?: number;
-    min?: number;
-    max?: number;
-    bucketSize?: number;
-    wildcardProjection?: Document;
-    hidden?: boolean;
-}
-export interface PostgresIndexOptions {
-    concurrently?: boolean;
-    name?: string;
-    operator?: string;
-    parser?: null | string;
-    prefix?: string;
-    unique?: boolean;
-    using?: PostgresIndexType;
-    where?: {
-        [opt: string]: any;
-    };
-}
-export {};

package/dist/interfaces/Params.d.ts

@@ -1,8 +0,0 @@
-import { Indexable } from './Indexable.js';
-export type UrlParams = {
-    [key: string]: string;
-};
-export type QueryParams = {
-    [key: string]: string | string[];
-};
-export type BodyParams = Indexable;

package/dist/interfaces/ProxyRoute.d.ts

@@ -1,42 +0,0 @@
-export declare enum ProxyRouteActions {
-    GET = "GET",
-    POST = "POST",
-    UPDATE = "PUT",
-    PATCH = "PATCH",
-    DELETE = "DELETE",
-    ALL = "ALL"
-}
-export interface ProxyRouteOptions {
-    path: string;
-    action?: ProxyRouteActions;
-    description?: string;
-    middlewares?: string[];
-}
-export interface ProxyMiddlewareOptions {
-    target: string;
-    changeOrigin?: boolean;
-    secure?: boolean;
-    context?: string | string[];
-    pathRewrite?: {
-        [path: string]: string;
-    };
-    headers?: {
-        [name: string]: string;
-    };
-    proxyTimeout?: number;
-    cookieDomainRewrite?: {
-        [hostname: string]: string;
-    };
-    autoRewrite?: boolean;
-    followRedirects?: boolean;
-    xfwd?: boolean;
-    ws?: boolean;
-    router?: {
-        [path: string]: string;
-    };
-    preserveHeaderKeyCase?: boolean;
-}
-export interface ConduitProxyObject {
-    options: ProxyRouteOptions;
-    proxy: ProxyMiddlewareOptions;
-}

package/dist/interfaces/RawQuery.d.ts

@@ -1,22 +0,0 @@
-export interface RawQuery {
-    mongoQuery?: RawMongoQuery;
-    sqlQuery?: RawSQLQuery;
-}
-export type RawMongoQuery = {
-    aggregate?: object[];
-    count?: object;
-    deleteOne?: object;
-    deleteMany?: object | object[];
-    drop?: object;
-    explain?: object;
-    find?: object;
-    insertOne?: object;
-    insertMany?: object | object[];
-    updateOne?: object | object[];
-    updateMany?: object | object[];
-    options?: object;
-};
-export type RawSQLQuery = {
-    query: string;
-    options?: object;
-};