@fraym/projections 0.4.1 → 0.6.0

package/README.md

@@ -168,6 +168,26 @@ Avaliable options for the filter type `Int` and `Float`:
 -   `lessThanOrEqual`
 -   `greaterThanOrEqual`
 
+With order:
+
+All order definitions are prioritized in the order that they are defined (the first definition is prioritized over the second).
+
+```typescript
+const data = await client.getDataList(
+    "tenantId",
+    "YourProjection",
+    undefined,
+    undefined,
+    undefined,
+    [
+        {
+            field: "fieldName",
+            descending: true, // omit this value for asc order
+        },
+    ]
+);
+```
+
 ### Gracefully close the clients
 
 You won't lose any data if you don't. Use it for your peace of mind.

package/dist/cmd/projections.js

@@ -206,7 +206,9 @@ const getValueString = (v) => {
 };
 const migrateSchemas = async (definitions, serverAddress, namespace) => {
     const managementClient = await (0, client_1.newManagementClient)({ serverAddress });
-    let existingProjections = (await managementClient.getAll()).filter(projectionName => !projectionName.startsWith("Crud") && projectionName.startsWith(namespace));
+    let existingProjections = (await managementClient.getAll()).filter(projectionName => !projectionName.startsWith("Crud") &&
+        !projectionName.startsWith("Fraym") &&
+        projectionName.startsWith(namespace));
     let createSchema = "";
     let updateSchema = "";
     const projectionsToCreate = [];

package/dist/delivery/client.d.ts

@@ -1,9 +1,10 @@
 import { ClientConfig } from "../config/config";
-import { GetProjectionData } from "./getData";
-import { Filter, GetProjectionDataList } from "./getDataList";
+import { Filter } from "./filter";
+import { GetProjectionDataList } from "./getDataList";
+import { Order } from "./order";
 export interface DeliveryClient {
-    getData: (tenantId: string, type: string, id: string, returnEmptyDataIfNotFound?: boolean) => Promise<GetProjectionData | null>;
-    getDataList: (tenantId: string, type: string, limit?: number, page?: number, filter?: Filter) => Promise<GetProjectionDataList | null>;
+    getData: <T extends {}>(tenantId: string, type: string, id: string, returnEmptyDataIfNotFound?: boolean) => Promise<T | null>;
+    getDataList: <T extends {}>(tenantId: string, type: string, limit?: number, page?: number, filter?: Filter, order?: Order[]) => Promise<GetProjectionDataList<T> | null>;
     close: () => Promise<void>;
 }
 export declare const newDeliveryClient: (config?: ClientConfig) => Promise<DeliveryClient>;

package/dist/delivery/client.js

@@ -16,8 +16,8 @@ const newDeliveryClient = async (config) => {
     const getData = async (tenantId, projection, id, returnEmptyDataIfNotFound = false) => {
         return await (0, getData_1.getProjectionData)(tenantId, projection, id, returnEmptyDataIfNotFound, serviceClient);
     };
-    const getDataList = async (tenantId, projection, limit = 0, page = 1, filter = { fields: {}, and: [], or: [] }) => {
-        return await (0, getDataList_1.getProjectionDataList)(tenantId, projection, limit, page, filter, serviceClient);
+    const getDataList = async (tenantId, projection, limit = 0, page = 1, filter = { fields: {}, and: [], or: [] }, order = []) => {
+        return await (0, getDataList_1.getProjectionDataList)(tenantId, projection, limit, page, filter, order, serviceClient);
     };
     const close = async () => {
         serviceClient.close();

package/dist/delivery/filter.d.ts

@@ -0,0 +1,12 @@
+import { DataFilter } from "@fraym/projections-proto";
+export interface Filter {
+    fields: Record<string, FieldFilter>;
+    and: Filter[];
+    or: Filter[];
+}
+export interface FieldFilter {
+    type: string;
+    operation: string;
+    value: any;
+}
+export declare const getProtobufDataFilter: (filter: Filter) => DataFilter;

package/dist/delivery/filter.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProtobufDataFilter = void 0;
+const getProtobufDataFilter = (filter) => {
+    const fields = {};
+    for (const fieldName in filter.fields) {
+        const field = filter.fields[fieldName];
+        let value = "";
+        if (field.type === "String" && typeof field.value == "string") {
+            value = field.value;
+        }
+        else {
+            value = JSON.stringify(field.value);
+        }
+        fields[fieldName] = {
+            operation: field.operation,
+            type: field.type,
+            value,
+        };
+    }
+    return {
+        fields: fields,
+        and: filter.and.map(and => (0, exports.getProtobufDataFilter)(and)),
+        or: filter.or.map(or => (0, exports.getProtobufDataFilter)(or)),
+    };
+};
+exports.getProtobufDataFilter = getProtobufDataFilter;

package/dist/delivery/getData.d.ts

@@ -1,3 +1,2 @@
 import { DeliveryServiceClient } from "@fraym/projections-proto";
-export declare type GetProjectionData = Record<string, any>;
-export declare const getProjectionData: (tenantId: string, projection: string, dataId: string, returnEmptyDataIfNotFound: boolean, serviceClient: DeliveryServiceClient) => Promise<GetProjectionData | null>;
+export declare const getProjectionData: <T extends {}>(tenantId: string, projection: string, dataId: string, returnEmptyDataIfNotFound: boolean, serviceClient: DeliveryServiceClient) => Promise<T | null>;

package/dist/delivery/getData.js

@@ -11,6 +11,7 @@ const getProjectionData = async (tenantId, projection, dataId, returnEmptyDataIf
             page: 0,
             returnEmptyDataIfNotFound,
             filter: { fields: {}, and: [], or: [] },
+            order: [],
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/dist/delivery/getDataList.d.ts

@@ -1,17 +1,9 @@
 import { DeliveryServiceClient } from "@fraym/projections-proto";
-export interface GetProjectionDataList {
+import { Filter } from "./filter";
+import { Order } from "./order";
+export interface GetProjectionDataList<T extends {}> {
     limit: number;
     page: number;
-    data: Record<string, any>[];
+    data: T[];
 }
-export interface Filter {
-    fields: Record<string, FieldFilter>;
-    and: Filter[];
-    or: Filter[];
-}
-export interface FieldFilter {
-    type: string;
-    operation: string;
-    value: any;
-}
-export declare const getProjectionDataList: (tenantId: string, projection: string, limit: number, page: number, filter: Filter, serviceClient: DeliveryServiceClient) => Promise<GetProjectionDataList | null>;
+export declare const getProjectionDataList: <T extends {}>(tenantId: string, projection: string, limit: number, page: number, filter: Filter, order: Order[], serviceClient: DeliveryServiceClient) => Promise<GetProjectionDataList<T> | null>;

package/dist/delivery/getDataList.js

@@ -1,30 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProjectionDataList = void 0;
-const getProtobufDataFilter = (filter) => {
-    const fields = {};
-    for (const fieldName in filter.fields) {
-        const field = filter.fields[fieldName];
-        let value = "";
-        if (field.type === "String" && typeof field.value == "string") {
-            value = field.value;
-        }
-        else {
-            value = JSON.stringify(field.value);
-        }
-        fields[fieldName] = {
-            operation: field.operation,
-            type: field.type,
-            value,
-        };
-    }
-    return {
-        fields: fields,
-        and: filter.and.map(and => getProtobufDataFilter(and)),
-        or: filter.or.map(or => getProtobufDataFilter(or)),
-    };
-};
-const getProjectionDataList = async (tenantId, projection, limit, page, filter, serviceClient) => {
+const filter_1 = require("./filter");
+const order_1 = require("./order");
+const getProjectionDataList = async (tenantId, projection, limit, page, filter, order, serviceClient) => {
     return new Promise((resolve, reject) => {
         serviceClient.getData({
             tenantId,
@@ -33,7 +12,8 @@ const getProjectionDataList = async (tenantId, projection, limit, page, filter,
             limit,
             page,
             returnEmptyDataIfNotFound: false,
-            filter: getProtobufDataFilter(filter),
+            filter: (0, filter_1.getProtobufDataFilter)(filter),
+            order: (0, order_1.getProtobufDataOrder)(order),
         }, (error, response) => {
             if (error) {
                 reject(error.message);

package/dist/delivery/order.d.ts

@@ -0,0 +1,6 @@
+import { DataOrder } from "@fraym/projections-proto";
+export interface Order {
+    field: string;
+    descending?: boolean;
+}
+export declare const getProtobufDataOrder: (order: Order[]) => DataOrder[];

package/dist/delivery/order.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProtobufDataOrder = void 0;
+const getProtobufDataOrder = (order) => {
+    return order.map(o => {
+        var _a;
+        return ({
+            field: o.field,
+            descending: (_a = o.descending) !== null && _a !== void 0 ? _a : false,
+        });
+    });
+};
+exports.getProtobufDataOrder = getProtobufDataOrder;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./management/client";
 export * from "./delivery/client";
-export { Filter, FieldFilter } from "./delivery/getDataList";
+export { Filter, FieldFilter } from "./delivery/filter";
+export { Order } from "./delivery/order";
 export { ClientConfig } from "./config/config";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraym/projections",
-    "version": "0.4.1",
+    "version": "0.6.0",
     "license": "UNLICENSED",
     "homepage": "https://github.com/fraym/projections-nodejs",
     "repository": {
@@ -27,10 +27,10 @@
         "projections": "dist/cmd/projections.js"
     },
     "dependencies": {
-        "@fraym/projections-proto": "^1.0.0-alpha.11",
+        "@fraym/projections-proto": "^1.0.0-alpha.12",
         "@graphql-tools/graphql-file-loader": "^7.5.11",
         "@graphql-tools/load": "^7.8.6",
-        "@grpc/grpc-js": "1.7.2",
+        "@grpc/grpc-js": "^1.8.7",
         "dotenv": "^16.0.3",
         "graphql": "^16.6.0",
         "yargs": "^17.6.2"