@forestadmin/agent 1.66.0 → 1.66.1

package/dist/utils/forest-schema/emitter.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = require("fs/promises");
+const json_stringify_pretty_compact_1 = __importDefault(require("json-stringify-pretty-compact"));
+const schema_generator_1 = __importDefault(require("./schema-generator"));
+const schema_serializer_1 = __importDefault(require("./schema-serializer"));
+// Load version from package.json at startup
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { version } = require('../../../package.json');
+/**
+ * Generate and dispatch dataSource schema on agent start.
+ */
+class SchemaEmitter {
+    static async getSerializedSchema(options, dataSource) {
+        const schema = options.isProduction
+            ? await SchemaEmitter.loadFromDisk(options.schemaPath)
+            : await schema_generator_1.default.generate(dataSource);
+        if (!options.isProduction) {
+            const pretty = (0, json_stringify_pretty_compact_1.default)(schema, { maxLength: 80 });
+            await (0, promises_1.writeFile)(options.schemaPath, pretty, { encoding: 'utf-8' });
+        }
+        return schema_serializer_1.default.serialize(schema, version);
+    }
+    static async loadFromDisk(schemaPath) {
+        try {
+            const fileContent = await (0, promises_1.readFile)(schemaPath, { encoding: 'utf-8' });
+            return JSON.parse(fileContent);
+        }
+        catch (e) {
+            throw new Error(`Cannot load ${schemaPath}. Providing a schema is mandatory in production mode.`);
+        }
+    }
+}
+exports.default = SchemaEmitter;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW1pdHRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy91dGlscy9mb3Jlc3Qtc2NoZW1hL2VtaXR0ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFDQSwwQ0FBa0Q7QUFDbEQsa0dBQXNEO0FBR3RELDBFQUFpRDtBQUNqRCw0RUFBbUQ7QUFPbkQsNENBQTRDO0FBQzVDLDhEQUE4RDtBQUM5RCxNQUFNLEVBQUUsT0FBTyxFQUFFLEdBQUcsT0FBTyxDQUFDLHVCQUF1QixDQUFDLENBQUM7QUFFckQ7O0dBRUc7QUFDSCxNQUFxQixhQUFhO0lBQ2hDLE1BQU0sQ0FBQyxLQUFLLENBQUMsbUJBQW1CLENBQzlCLE9BQWdCLEVBQ2hCLFVBQXNCO1FBRXRCLE1BQU0sTUFBTSxHQUFjLE9BQU8sQ0FBQyxZQUFZO1lBQzVDLENBQUMsQ0FBQyxNQUFNLGFBQWEsQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQztZQUN0RCxDQUFDLENBQUMsTUFBTSwwQkFBZSxDQUFDLFFBQVEsQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUUvQyxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksRUFBRTtZQUN6QixNQUFNLE1BQU0sR0FBRyxJQUFBLHVDQUFTLEVBQUMsTUFBTSxFQUFFLEVBQUUsU0FBUyxFQUFFLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDcEQsTUFBTSxJQUFBLG9CQUFTLEVBQUMsT0FBTyxDQUFDLFVBQVUsRUFBRSxNQUFNLEVBQUUsRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLENBQUMsQ0FBQztTQUNwRTtRQUVELE9BQU8sMkJBQWdCLENBQUMsU0FBUyxDQUFDLE1BQU0sRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNyRCxDQUFDO0lBRU8sTUFBTSxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsVUFBa0I7UUFDbEQsSUFBSTtZQUNGLE1BQU0sV0FBVyxHQUFHLE1BQU0sSUFBQSxtQkFBUSxFQUFDLFVBQVUsRUFBRSxFQUFFLFFBQVEsRUFBRSxPQUFPLEVBQUUsQ0FBQyxDQUFDO1lBRXRFLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQztTQUNoQztRQUFDLE9BQU8sQ0FBQyxFQUFFO1lBQ1YsTUFBTSxJQUFJLEtBQUssQ0FDYixlQUFlLFVBQVUsdURBQXVELENBQ2pGLENBQUM7U0FDSDtJQUNILENBQUM7Q0FDRjtBQTVCRCxnQ0E0QkMifQ==

package/dist/utils/forest-schema/schema-generator.d.ts

@@ -0,0 +1,6 @@
+import { DataSource } from '@forestadmin/datasource-toolkit';
+import { ForestServerCollection } from './types';
+export default class SchemaGenerator {
+    static generate(dataSource: DataSource): Promise<ForestServerCollection[]>;
+}
+//# sourceMappingURL=schema-generator.d.ts.map

package/dist/utils/forest-schema/schema-generator.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const generator_collection_1 = __importDefault(require("./generator-collection"));
+class SchemaGenerator {
+    static async generate(dataSource) {
+        return Promise.all(dataSource.collections.map(collection => generator_collection_1.default.buildSchema(collection)));
+    }
+}
+exports.default = SchemaGenerator;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hLWdlbmVyYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy91dGlscy9mb3Jlc3Qtc2NoZW1hL3NjaGVtYS1nZW5lcmF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFFQSxrRkFBK0Q7QUFHL0QsTUFBcUIsZUFBZTtJQUNsQyxNQUFNLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxVQUFzQjtRQUMxQyxPQUFPLE9BQU8sQ0FBQyxHQUFHLENBQ2hCLFVBQVUsQ0FBQyxXQUFXLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUMsOEJBQXlCLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQzVGLENBQUM7SUFDSixDQUFDO0NBQ0Y7QUFORCxrQ0FNQyJ9

package/dist/utils/forest-schema/schema-serializer.d.ts

@@ -0,0 +1,12 @@
+import { ForestServerCollection } from './types';
+declare type SerializedSchema = {
+    meta: {
+        schemaFileHash: string;
+    };
+};
+export default class SchemaSerializer {
+    private static readonly meta;
+    static serialize(schema: ForestServerCollection[], lianaVersion: string): SerializedSchema;
+}
+export {};
+//# sourceMappingURL=schema-serializer.d.ts.map

package/dist/utils/forest-schema/schema-serializer.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const crypto_1 = __importDefault(require("crypto"));
+const json_api_serializer_1 = __importDefault(require("json-api-serializer"));
+class SchemaSerializer {
+    static serialize(schema, lianaVersion) {
+        const hash = crypto_1.default.createHash('sha1').update(JSON.stringify(schema)).digest('hex');
+        // Build serializer
+        const serializer = new json_api_serializer_1.default();
+        serializer.register('collections', {
+            // Pass the metadata provided to the serialization fn
+            topLevelMeta: (extraData) => extraData,
+            relationships: {
+                segments: { type: 'segments' },
+                actions: { type: 'actions' },
+            },
+        });
+        serializer.register('segments', {});
+        serializer.register('actions', {});
+        // Serialize
+        return serializer.serialize('collections', schema.map(c => ({ id: c.name, ...c })), { ...SchemaSerializer.meta, liana_version: lianaVersion, schemaFileHash: hash });
+    }
+}
+exports.default = SchemaSerializer;
+SchemaSerializer.meta = {
+    liana: 'forest-nodejs-agent',
+    stack: {
+        engine: 'nodejs',
+        engine_version: process.versions && process.versions.node,
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2NoZW1hLXNlcmlhbGl6ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdXRpbHMvZm9yZXN0LXNjaGVtYS9zY2hlbWEtc2VyaWFsaXplci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLG9EQUE0QjtBQUM1Qiw4RUFBb0Q7QUFNcEQsTUFBcUIsZ0JBQWdCO0lBU25DLE1BQU0sQ0FBQyxTQUFTLENBQUMsTUFBZ0MsRUFBRSxZQUFvQjtRQUNyRSxNQUFNLElBQUksR0FBRyxnQkFBTSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUVwRixtQkFBbUI7UUFDbkIsTUFBTSxVQUFVLEdBQUcsSUFBSSw2QkFBaUIsRUFBRSxDQUFDO1FBRTNDLFVBQVUsQ0FBQyxRQUFRLENBQUMsYUFBYSxFQUFFO1lBQ2pDLHFEQUFxRDtZQUNyRCxZQUFZLEVBQUUsQ0FBQyxTQUFrQixFQUFFLEVBQUUsQ0FBQyxTQUFTO1lBQy9DLGFBQWEsRUFBRTtnQkFDYixRQUFRLEVBQUUsRUFBRSxJQUFJLEVBQUUsVUFBVSxFQUFFO2dCQUM5QixPQUFPLEVBQUUsRUFBRSxJQUFJLEVBQUUsU0FBUyxFQUFFO2FBQzdCO1NBQ0YsQ0FBQyxDQUFDO1FBQ0gsVUFBVSxDQUFDLFFBQVEsQ0FBQyxVQUFVLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFDcEMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFFbkMsWUFBWTtRQUNaLE9BQU8sVUFBVSxDQUFDLFNBQVMsQ0FDekIsYUFBYSxFQUNiLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLEVBQUUsRUFBRSxFQUFFLENBQUMsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLEVBQUUsQ0FBQyxDQUFDLEVBQ3ZDLEVBQUUsR0FBRyxnQkFBZ0IsQ0FBQyxJQUFJLEVBQUUsYUFBYSxFQUFFLFlBQVksRUFBRSxjQUFjLEVBQUUsSUFBSSxFQUFFLENBQzVELENBQUM7SUFDeEIsQ0FBQzs7QUFoQ0gsbUNBaUNDO0FBaEN5QixxQkFBSSxHQUFHO0lBQzdCLEtBQUssRUFBRSxxQkFBcUI7SUFDNUIsS0FBSyxFQUFFO1FBQ0wsTUFBTSxFQUFFLFFBQVE7UUFDaEIsY0FBYyxFQUFFLE9BQU8sQ0FBQyxRQUFRLElBQUksT0FBTyxDQUFDLFFBQVEsQ0FBQyxJQUFJO0tBQzFEO0NBQ0YsQ0FBQyJ9

package/dist/utils/forest-schema/types.d.ts

@@ -0,0 +1,85 @@
+import { PrimitiveTypes } from '@forestadmin/datasource-toolkit';
+export declare type ForestServerColumnType = PrimitiveTypes | [ForestServerColumnType] | {
+    fields: Array<{
+        field: string;
+        type: ForestServerColumnType;
+    }>;
+};
+export declare type ForestServerCollection = {
+    name: string;
+    icon: null;
+    integration: null;
+    isReadOnly: boolean;
+    isSearchable: boolean;
+    isVirtual: false;
+    onlyForRelationships: boolean;
+    paginationType: 'page';
+    actions: Array<ForestServerAction>;
+    fields: Array<ForestServerField>;
+    segments: Array<ForestServerSegment>;
+};
+export declare type ForestServerAction = {
+    id: string;
+    name: string;
+    type: 'single' | 'bulk' | 'global';
+    baseUrl: string;
+    endpoint: string;
+    httpMethod: 'POST';
+    redirect: unknown;
+    download: boolean;
+    fields: ForestServerActionField[];
+    hooks: {
+        load: boolean;
+        change: Array<unknown>;
+    };
+};
+export declare type ForestServerActionField = {
+    value: unknown;
+    defaultValue: unknown;
+    description: string | null;
+    enums: string[];
+    field: string;
+    hook: string;
+    isReadOnly: boolean;
+    isRequired: boolean;
+    reference: string | null;
+    type: ForestServerColumnType;
+    widget: null | 'belongsto select' | 'file picker';
+};
+export declare type ForestServerField = Partial<{
+    field: string;
+    type: ForestServerColumnType;
+    defaultValue: unknown;
+    enums: null | string[];
+    integration: null;
+    isFilterable: boolean;
+    isPrimaryKey: boolean;
+    isReadOnly: boolean;
+    isRequired: boolean;
+    isSortable: boolean;
+    isVirtual: boolean;
+    reference: null | string;
+    inverseOf: null | string;
+    relationship: 'BelongsTo' | 'BelongsToMany' | 'HasMany' | 'HasOne';
+    validations: Array<{
+        message: string | null;
+        type: ValidationType;
+        value: unknown;
+    }>;
+}>;
+export declare type ForestServerSegment = {
+    id: string;
+    name: string;
+};
+export declare enum ValidationType {
+    Present = "is present",
+    GreaterThan = "is greater than",
+    LessThan = "is less than",
+    Before = "is before",
+    After = "is after",
+    LongerThan = "is longer than",
+    ShorterThan = "is shorter than",
+    Contains = "contains",
+    Like = "is like"
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/utils/forest-schema/types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationType = void 0;
+var ValidationType;
+(function (ValidationType) {
+    ValidationType["Present"] = "is present";
+    ValidationType["GreaterThan"] = "is greater than";
+    ValidationType["LessThan"] = "is less than";
+    ValidationType["Before"] = "is before";
+    ValidationType["After"] = "is after";
+    ValidationType["LongerThan"] = "is longer than";
+    ValidationType["ShorterThan"] = "is shorter than";
+    ValidationType["Contains"] = "contains";
+    ValidationType["Like"] = "is like";
+})(ValidationType = exports.ValidationType || (exports.ValidationType = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdXRpbHMvZm9yZXN0LXNjaGVtYS90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUEwRUEsSUFBWSxjQVVYO0FBVkQsV0FBWSxjQUFjO0lBQ3hCLHdDQUFzQixDQUFBO0lBQ3RCLGlEQUErQixDQUFBO0lBQy9CLDJDQUF5QixDQUFBO0lBQ3pCLHNDQUFvQixDQUFBO0lBQ3BCLG9DQUFrQixDQUFBO0lBQ2xCLCtDQUE2QixDQUFBO0lBQzdCLGlEQUErQixDQUFBO0lBQy9CLHVDQUFxQixDQUFBO0lBQ3JCLGtDQUFnQixDQUFBO0FBQ2xCLENBQUMsRUFWVyxjQUFjLEdBQWQsc0JBQWMsS0FBZCxzQkFBYyxRQVV6QiJ9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forestadmin/agent",
-  "version": "1.66.0",
+  "version": "1.66.1",
   "main": "dist/index.js",
   "license": "GPL-3.0",
   "publishConfig": {
@@ -60,5 +60,8 @@
     "openid-client": "^5.7.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.0"
+  },
+  "overrides": {
+    "@paralleldrive/cuid2": "2.2.2"
   }
 }